Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Group

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly client

client: Client

closed

closed: boolean

createdAt

createdAt: number

creatorID

creatorID: string

Readonly id

id: string

imageURL

imageURL: null | string

inviteQR

inviteQR: null | string

inviteURL

inviteURL: null | string

joinQuestion

joinQuestion: null | string

lastMessage

lastMessage: MessagePreview

likeIcon

likeIcon: null | object

maxMembers

maxMembers: number

Readonly members

members: MemberManager

messageCount

messageCount: number

Optional messageDeletionMode

messageDeletionMode: string[]

Optional messageDeletionPeriod

messageDeletionPeriod: number

Readonly messages

messages: GroupMessageManager

Optional mutedUntil

mutedUntil: null | number

name

name: string

officeMode

officeMode: boolean

phoneNumber

phoneNumber: null | string

Readonly polls

polls: PollManager

requiresApproval

requiresApproval: boolean

showJoinQuestion

showJoinQuestion: boolean

theme

theme: null | string

Readonly type

type: Group = ...

updatedAt

updatedAt: number

Accessors

me

  • get me(): undefined | Member

  • Returns undefined | Member

Methods

_clone

  • _clone(): any

  • Returns any

_patch

  • _patch(data: Partial<APIGroup>): Group

  • Parameters

    • data: Partial<APIGroup>

    Returns Group

changeNickname

  • changeNickname(nickname: string): Promise<Member>

  • Parameters

    • nickname: string

    Returns Promise<Member>

delete

  • delete(): Promise<void>

  • Returns Promise<void>

fetch

  • fetch(): Promise<Group>

  • Returns Promise<Group>

leave

  • Returns Promise<FormerGroup>

send

transferOwnershipTo

  • transferOwnershipTo(newOwner: string): Promise<Group>

  • Parameters

    • newOwner: string

    Returns Promise<Group>

update

  • update(options: GroupUpdateOptions): Promise<Group>

  • Parameters

    • options: GroupUpdateOptions

    Returns Promise<Group>

Static _patch

Static dataFromChat

  • dataFromChat(data: APIChat): ChannelData

  • Parameters

    • data: APIChat

    Returns ChannelData

Static dataFromGroup

  • dataFromGroup(data: APIGroup): ChannelData

  • Parameters

    • data: APIGroup

    Returns ChannelData

Generated using TypeDoc