Interface IPostArgs

Options specifying the data that is to be posted.

interface IPostArgs {
    changePassword?: IChangePasswordArgs;
    conversationId?: string;
    id?: string;
    profileBanner?: string;
    profileImage?: string;
    profileOptions?: IProfileUpdateOptions;
    tweet?: INewTweet;
    upload?: IUploadArgs;
    userId?: string;
    username?: string;
}

Implemented by

Properties

changePassword? conversationId? id? profileBanner? profileImage? profileOptions? tweet? upload? userId? username?

Properties

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.

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

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