Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Team

Team Structure an application's team

Hierarchy

Index

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysTeam

client

client: ShardClient

icon

icon: null | string = null

id

id: string = ""

members

members: BaseCollection<string, TeamMember> = new BaseCollection<string, TeamMember>()

name

name: string = ""

ownerUserId

ownerUserId: string = ""

Optional payoutAccountStatus

payoutAccountStatus: TeamPayoutAccountStatuses

Accessors

createdAt

  • get createdAt(): Date
  • Returns Date

createdAtUnix

  • get createdAtUnix(): number
  • Returns number

owner

  • Returns null | TeamMember

shardId

  • get shardId(): number
  • Returns number

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any
  • Parameters

    • key: string

    Returns any

_setFromSnake

  • _setFromSnake(key: string, value: any): any
  • Parameters

    • key: string
    • value: any

    Returns any

addMember

  • addMember(options: AddTeamMember): Promise<any>
  • Parameters

    • options: AddTeamMember

    Returns Promise<any>

delete

  • delete(options?: RequestTypes.DeleteTeam): Promise<any>
  • Parameters

    • Optional options: RequestTypes.DeleteTeam

    Returns Promise<any>

difference

  • difference(key: string, value: any): [boolean, any]
  • Parameters

    • key: string
    • value: any

    Returns [boolean, any]

differences

edit

  • edit(options?: RequestTypes.EditTeam): Promise<any>
  • Parameters

    • Optional options: RequestTypes.EditTeam

    Returns Promise<any>

fetch

  • fetch(): Promise<Team>
  • Returns Promise<Team>

fetchApplications

  • fetchApplications(): Promise<any>
  • Returns Promise<any>

fetchMember

  • fetchMember(userId: string): Promise<TeamMember>
  • Parameters

    • userId: string

    Returns Promise<TeamMember>

fetchMembers

  • fetchMembers(): Promise<BaseCollection<string, TeamMember>>
  • Returns Promise<BaseCollection<string, TeamMember>>

fetchPayouts

  • fetchPayouts(options?: RequestTypes.FetchTeamPayouts): Promise<any>
  • Parameters

    • Optional options: RequestTypes.FetchTeamPayouts

    Returns Promise<any>

merge

mergeValue

  • mergeValue(key: string, value: any): void
  • Parameters

    • key: string
    • value: any

    Returns void

removeTeamMember

  • removeTeamMember(userId: string): Promise<any>
  • Parameters

    • userId: string

    Returns Promise<any>

toJSON

  • toJSON(): object
  • Returns object

Generated using TypeDoc