Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PortalGroup

Hierarchy

Index

Properties

access

access: "public" | "private" | "org"

The access privileges on the group which determines who can see and access the group.

Read more...

created

created: Date

The date the group was created.

Read more...

declaredClass

declaredClass: string

description

description: string

A detailed description of the group.

Read more...

destroyed

destroyed: boolean

id

id: string

The unique id for the group.

Read more...

initialized

initialized: boolean

isInvitationOnly

isInvitationOnly: boolean

If set to true, then users will not be able to apply to join the group.

Read more...

modified

modified: Date

The date the group was last modified.

Read more...

owner

owner: string

The username of the group's owner.

Read more...

portal

portal: Portal

The portal associated with the group.

Read more...

snippet

snippet: string

A short summary that describes the group.

Read more...

tags

tags: string[]

User defined tags that describe the group.

Read more...

Readonly thumbnailUrl

thumbnailUrl: string

The URL to the thumbnail used for the group.

Read more...

title

title: string

The title of the group.

Read more...

Readonly url

url: string

The URL to the group.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PortalGroup

destroy

  • destroy(): void
  • Returns void

fetchCategorySchema

  • If present, fetches the group's category schema.

    Read more...

    Parameters

    Returns Promise<any[]>

fetchMembers

  • Fetches the current members of the group.

    Read more...

    Parameters

    Returns Promise<any>

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getThumbnailUrl

  • getThumbnailUrl(width?: number): string
  • Get the URL to the thumbnail image for the group.

    Read more...

    Parameters

    • Optional width: number

    Returns string

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

queryItems

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PortalGroup

  • Parameters

    Returns PortalGroup

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc