Protocol reference

Available methods and types

Auth

Methods

authorize createEmailVerificationChallenge getSessions lookupInvite resendEmailVerification resetPassword revokeSessions signIn signUp useInvite verifyEmail

Classes

Authorization CreatedInvite EmailVerificationChallenge InviteList InvitePreview Session Sessions

Enums

Billing

Methods

cancelSubscription getProducts getSubscription requestPaymentLink

Classes

PaymentLink Product ProductPrice Products Subscription

Chats

Methods

addChatMember createChat createChatInvite deleteChatInvite editChat editChatMember getChat getChatMembers getChats listChatInvites markChatRead removeChatMember setTyping

Classes

Chat ChatMembers Chats

Enums

Core

Methods

Classes

ClientMessage Entrypoints Initialized RPCError RPCResult ServerMessage

Discovery

Methods

getDiscoverableCommunities

Classes

DiscoveryCommunities DiscoveryCommunityListing DiscoveryListingInfo

Friends

Methods

changeRelationship getRelationships syncFriends

Classes

Media

Methods

downloadFilePart uploadFilePart

Classes

File FileMetadata FilePart FileRef Files MediaEmbed MediaFile MediaRef MediaRefEmbed MediaRefUploadedFile MessageMedia UploadedFileRef

Messages

Methods

deleteMessage editMessage forwardMessage getEmbedPreview getHistory getPinnedMessages getUnreadMentions reportMessage search sendMessage setInteractionResponse setMessagePin submitInteraction

Classes

InteractionResponse MessageButton Messages SentMessage UnreadMentions

Oauth

Methods

authorize getApp

Classes

App Authorization

Reactions

Methods

addReaction removeReaction

Classes

MessageReactionField MessageReactions ReactionEmoji

Refs

Classes

ChannelRef ChatRef GroupRef RefSelf StickerPackRef UserRef

Settings

Methods

changeEmail changeNotificationPreferences changePassword changeStatus deleteAccount editProfile editProfileBanner editProfilePhoto editUserSettings getAccount registerPushSubscription requestTakeout setupTotp unregisterPushSubscription

Classes

Account BackupCode Totp UserSettings

Stickers

Methods

addStickerToPack getSavedStickers getStickerFiles getStickerPack removeStickerFromPack

Classes

SavedStickers StickerPack

Users

Methods

getProfile lookupUsername

Classes

Profile UserDetails

Voice

Methods

Classes

RoomInfo RoomParticipant RoomState UpdateRoomParticipant UpdateRoomState