Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Group

Hierarchy

  • Group

Index

Constructors

Methods

Constructors

constructor

  • new Group(guid: string, name?: string, type?: string, passsword?: string, icon?: string, description?: string, hasJoined?: boolean): Group

  • Creates an instance of Group.

    memberof

    Group

    Parameters

    • guid: string
    • Optional name: string
    • Optional type: string
    • Optional passsword: string
    • Optional icon: string
    • Optional description: string
    • Optional hasJoined: boolean

    Returns Group

Methods

getCreatedAt

  • getCreatedAt(): number

  • Method to get the created at timestamp of the group.

    Returns number

getDescription

  • getDescription(): string

  • Method to get description of the group.

    Returns string

getGuid

  • getGuid(): string

  • Method to get GUID of the group.

    Returns string

getHasJoined

  • getHasJoined(): boolean

  • Method to get the joinedAt of the group.

    Returns boolean

getIcon

  • getIcon(): string

  • Method to get icon of the group.

    Returns string

getJoinedAt

  • getJoinedAt(): string

  • Method to get joinedAt timestamp of the logged-in user.

    Returns string

getMembersCount

  • getMembersCount(): number

  • Method to get members count of the group.

    Returns number

getMetadata

  • getMetadata(): string

  • Method to get metadata of the group.

    Returns string

getName

  • getName(): string

  • Method to get name of the group.

    Returns string

getOwner

  • getOwner(): string

  • Method to get owner of the group.

    Returns string

getPassword

  • getPassword(): string

  • Method to get password of the group.

    Returns string

getScope

  • getScope(): string

  • Method to get scope of the logged-in user.

    Returns string

getTags

  • getTags(): String[]

  • Method to get tags of the group.

    Returns String[]

getType

  • getType(): string

  • Method to get the type of the group.

    Returns string

getUpdatedAt

  • getUpdatedAt(): number

  • Method to get the updated at timestamp of the group.

    Returns number

setCreatedAt

  • setCreatedAt(createdAt: number): void

  • Method to set the created at timestamp of the group.

    Parameters

    • createdAt: number

    Returns void

setDescription

  • setDescription(description: string): void

  • Method to set description of the group.

    Parameters

    • description: string

    Returns void

setGuid

  • setGuid(guid: string): void

  • Method to set GUID of the group.

    Parameters

    • guid: string

    Returns void

setHasJoined

  • setHasJoined(hasJoined: boolean): void

  • Method to set the joinedAt of the group.

    Parameters

    • hasJoined: boolean

    Returns void

setIcon

  • setIcon(icon: string): void

  • Method to set icon of the group.

    Parameters

    • icon: string

    Returns void

setJoinedAt

  • setJoinedAt(joinedAt: string): void

  • Method to set joinedAt timestamp of the logged-in user in the group.

    Parameters

    • joinedAt: string

    Returns void

setMembersCount

  • setMembersCount(membersCount: number): void

  • Method to set members count of the group.

    Parameters

    • membersCount: number

    Returns void

setMetadata

  • setMetadata(metadata: string): void

  • Method to set metadata of the group.

    Parameters

    • metadata: string

    Returns void

setName

  • setName(name: string): void

  • Method to set name of the group.

    Parameters

    • name: string

    Returns void

setOwner

  • setOwner(owner: string): void

  • Method to set owner of the group.

    Parameters

    • owner: string

    Returns void

setPassword

  • setPassword(password: string): void

  • Method to set password of the group.

    Parameters

    • password: string

    Returns void

setScope

  • setScope(scope: string): void

  • Method to set scope of the logged-in user in the group.

    Parameters

    • scope: string

    Returns void

setTags

  • setTags(tags: String[]): void

  • Method to set tags of the group.

    Parameters

    • tags: String[]

    Returns void

setType

  • setType(type: string): void

  • Method to set the type of the group.

    Parameters

    • type: string

    Returns void

setUpdatedAt

  • setUpdatedAt(updatedAt: number): void

  • Method to set updated at timestamp of the group.

    Parameters

    • updatedAt: number

    Returns void