Interface IPostArgs

Options specifying the data that is to be posted.

interface IPostArgs {
    audioOnly?: boolean;
    calendarProvider?: CalendarProvider;
    call?: INewCall;
    callCustomization?: ICallCustomization;
    callOccurrence?: ICallOccurrenceOptions;
    callUpdates?: ICallUpdates;
    changePassword?: IChangePasswordArgs;
    conversationId?: string;
    id?: string;
    list?: INewList;
    listUpdates?: IListUpdates;
    mediaMetadata?: IMediaMetadataArgs;
    profileBanner?: string;
    profileImage?: string;
    profileOptions?: IProfileUpdateOptions;
    reminder?: number;
    rsvp?: CallRsvpStatus;
    tweet?: INewTweet;
    upload?: IUploadArgs;
    userId?: string;
    username?: string;
}

Implemented by

Properties

audioOnly? calendarProvider? call? callCustomization? callOccurrence? callUpdates? changePassword? conversationId? id? list? listUpdates? mediaMetadata? profileBanner? profileImage? profileOptions? reminder? rsvp? tweet? upload? userId? username?

Properties

OptionalaudioOnly

audioOnly?: boolean

Whether the call to create is audio-only.

Remarks

Used only when creating a call using ResourceType.CALL_CREATE.

OptionalcalendarProvider

calendarProvider?: CalendarProvider

The external calendar provider.

Remarks

Required only when unlinking a calendar using ResourceType.CALL_CALENDAR_UNLINK.

Optionalcall

call?: INewCall

The call that is to be scheduled.

Remarks

Required only when scheduling a call using ResourceType.CALL_SCHEDULE.

OptionalcallCustomization

callCustomization?: ICallCustomization

The customization (color, visibility) to apply to a scheduled call.

Remarks

Required only when customizing a scheduled call using ResourceType.CALL_CUSTOMIZE.

OptionalcallOccurrence

callOccurrence?: ICallOccurrenceOptions

The occurrence(s) of the scheduled call to act on.

Remarks

Used only with the following resources:

OptionalcallUpdates

callUpdates?: ICallUpdates

The updates to apply to a scheduled call.

Remarks

Required only when updating a scheduled call using ResourceType.CALL_UPDATE.

OptionalchangePassword

changePassword?: IChangePasswordArgs

Password change arguments.

Remarks

Required only when changing password using ResourceType.USER_PASSWORD_CHANGE.

OptionalconversationId

conversationId?: string

The id of the conversation to delete.

Remarks

Required only when deleting a conversation using ResourceType.DM_DELETE_CONVERSATION

Optionalid

id?: string

The id of the target resource.

Remarks

Required only when posting using the following resources:

For ResourceType.USER_USERNAME_CHANGE, use IPostArgs.username. id is still accepted for backward compatibility.

Optionallist

list?: INewList

The list that is to be created.

Remarks

Required only when creating a list using the following resources:

OptionallistUpdates

listUpdates?: IListUpdates

The updates to apply to an existing list.

Remarks

Required only when updating a list using ResourceType.LIST_UPDATE.

OptionalmediaMetadata

mediaMetadata?: IMediaMetadataArgs

The metadata to set for an already uploaded media item.

Remarks

Required only when setting media metadata using ResourceType.MEDIA_METADATA_CREATE.

OptionalprofileBanner

profileBanner?: string

Base64-encoded profile banner data.

Remarks

Required only when updating profile banner using ResourceType.USER_PROFILE_BANNER_UPDATE.

OptionalprofileImage

profileImage?: string

Base64-encoded profile image data.

Remarks

Required only when updating profile image using ResourceType.USER_PROFILE_IMAGE_UPDATE.

OptionalprofileOptions

profileOptions?: IProfileUpdateOptions

Profile update options.

Remarks

Required only when updating user profile using ResourceType.USER_PROFILE_UPDATE

Optionalreminder

reminder?: number

The number of minutes before a scheduled call at which to be reminded of it (0 to 10080).

Remarks

Required only when setting a reminder using ResourceType.CALL_REMINDER.

Optionalrsvp

rsvp?: CallRsvpStatus

The RSVP status to respond to a scheduled call invitation with.

Remarks

Required only when responding to an invitation using ResourceType.CALL_RSVP.

Optionaltweet

tweet?: INewTweet

The tweet that is to be posted.

Remarks

Required only when posting a tweet using ResourceType.TWEET_POST

Optionalupload

upload?: IUploadArgs

The media file to be uploaded.

Remarks

Required only when uploading a media using the following resources:

OptionaluserId

userId?: string

The id of the target user.

Remarks

Required only for the following resources:

Optionalusername

username?: string

The new username to set.

Remarks

Required only when changing username using ResourceType.USER_USERNAME_CHANGE.

Settings

Member Visibility

On This Page

Properties