Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupChannel

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

client

client: Client

createdAt

createdAt: number

Optional icon

icon: undefined | string

Optional iconURL

iconURL: undefined | string

id

id: string

lastMessageID

lastMessageID: string

mention

mention: string

messages

messages: Collection<Message<PrivateChannel>>

name

name: string

ownerID

ownerID: string

recipient

recipient: User

recipients

recipients: Collection<User>

type

type: 3

Methods

addMessageReaction

  • addMessageReaction(messageID: string, reaction: string, userID?: string): Promise<void>

  • Parameters

    • messageID: string
    • reaction: string
    • Optional userID: string

    Returns Promise<void>

addRecipient

  • addRecipient(userID: string): Promise<void>

  • Parameters

    • userID: string

    Returns Promise<void>

createMessage

deleteMessage

  • deleteMessage(messageID: string, reason?: string): Promise<void>

  • Parameters

    • messageID: string
    • Optional reason: string

    Returns Promise<void>

dynamicIconURL

  • dynamicIconURL(format?: string, size?: number): string

  • Parameters

    • Optional format: string
    • Optional size: number

    Returns string

edit

  • edit(options: { icon?: undefined | string; name?: undefined | string; ownerID?: undefined | string }): Promise<GroupChannel>

  • Parameters

    • options: { icon?: undefined | string; name?: undefined | string; ownerID?: undefined | string }
      • Optional icon?: undefined | string
      • Optional name?: undefined | string
      • Optional ownerID?: undefined | string

    Returns Promise<GroupChannel>

editMessage

getMessage

getMessageReaction

  • getMessageReaction(messageID: string, reaction: string, limit?: number, before?: string, after?: string): Promise<User[]>

  • Parameters

    • messageID: string
    • reaction: string
    • Optional limit: number
    • Optional before: string
    • Optional after: string

    Returns Promise<User[]>

getMessages

  • getMessages(limit?: number, before?: string, after?: string, around?: string): Promise<Message<PrivateChannel>[]>

  • Parameters

    • Optional limit: number
    • Optional before: string
    • Optional after: string
    • Optional around: string

    Returns Promise<Message<PrivateChannel>[]>

getPins

inspect

leave

  • leave(): Promise<void>

  • Returns Promise<void>

pinMessage

  • pinMessage(messageID: string): Promise<void>

  • Parameters

    • messageID: string

    Returns Promise<void>

removeMessageReaction

  • removeMessageReaction(messageID: string, reaction: string, userID?: string): Promise<void>

  • Parameters

    • messageID: string
    • reaction: string
    • Optional userID: string

    Returns Promise<void>

removeRecipient

  • removeRecipient(userID: string): Promise<void>

  • Parameters

    • userID: string

    Returns Promise<void>

ring

  • ring(recipient: string[]): void

  • Parameters

    • recipient: string[]

    Returns void

sendTyping

  • sendTyping(): Promise<void>

syncCall

  • syncCall(): void

toJSON

unpinMessage

  • unpinMessage(messageID: string): Promise<void>

  • Parameters

    • messageID: string

    Returns Promise<void>

unsendMessage

  • unsendMessage(messageID: string): Promise<void>

  • Parameters

    • messageID: string

    Returns Promise<void>

Static from

Generated using TypeDoc