Class Miscellaneous

Miscellaneous routes.

Hierarchy

Miscellaneous

Index

Constructors

Methods

deleteUserStatus getSocialLink getUser getUserGuilds updateUserStatus

Constructors

constructor

new Miscellaneous(manager): Miscellaneous
Parameters
- manager: RESTManager
  
  REST Manager needed to execute request.
Returns Miscellaneous
- Defined in lib/routes/Misc.ts:15

Methods

deleteUserStatus

deleteUserStatus(userID): Promise<void>
Delete a user's status, this includes the bot's one.
Parameters
- userID: string
  
  User ID (@me can be used).
Returns Promise<void>
- Defined in lib/routes/Misc.ts:73

getSocialLink

getSocialLink(guildID, memberID, socialMediaName): Promise<SocialLink>
Get a specified social link from the member, if member is connected to them through Guilded.
Parameters
- guildID: string
  
  The ID of the guild the member is in.
- memberID: string
  
  The ID of the member to get their social link.
- socialMediaName: string
  
  Name of a social media linked to this member.
Returns Promise<SocialLink>
- Defined in lib/routes/Misc.ts:24

getUser

getUser(userID): Promise<User>
Get a user.

Note: when getting the bot's user, only the information specific to 'User' will be returned. If you'd like to get the UserClient (the bot itself), use Client#user.
Parameters
- userID: string
  
  The ID of the user to get.
Returns Promise<User>
- Defined in lib/routes/Misc.ts:38

getUserGuilds

getUserGuilds(userID): Promise<Guild[]>
Retrieve user's joined servers.
Parameters
- userID: string
  
  ID of the user. (@me can be used to select your instance)
Returns Promise<Guild[]>
- Defined in lib/routes/Misc.ts:49

updateUserStatus

updateUserStatus(userID, options): Promise<void>
Change a user's status, this includes the bot's one.
Parameters
- userID: string
  
  User ID (@me can be used).
- options: PUTUserStatusBody
  
  Status options
Returns Promise<void>
- Defined in lib/routes/Misc.ts:61