Interface IOrganizationService

Organization service interface

interface IOrganizationService {
    fetchOrganizationAvatars(
        hubUrl: string,
        organizationId: string,
    ): Promise<OrganizationAvatar[]>;
    getOrganizationInfo(
        hubUrl: string,
        hubId: string,
    ): Promise<OrganizationInfo>;
    selectAvatar(
        avatars: OrganizationAvatar[],
        options?: { avatarId?: string; avatarSelection?: string },
    ): null | OrganizationAvatar;
}

Index

Methods

fetchOrganizationAvatars getOrganizationInfo selectAvatar

Methods

fetchOrganizationAvatars

fetchOrganizationAvatars(
hubUrl: string,
organizationId: string,
): Promise<OrganizationAvatar[]>
Fetch organization avatars
Parameters
- hubUrl: string
- organizationId: string
Returns Promise<OrganizationAvatar[]>
- Defined in packages/core/src/interfaces/IOrganizationService.ts:50

getOrganizationInfo

getOrganizationInfo(hubUrl: string, hubId: string): Promise<OrganizationInfo>
Get organization info from hub ID
Parameters
- hubUrl: string
- hubId: string
Returns Promise<OrganizationInfo>
- Defined in packages/core/src/interfaces/IOrganizationService.ts:45

selectAvatar

selectAvatar(
avatars: OrganizationAvatar[],
options?: { avatarId?: string; avatarSelection?: string },
): null | OrganizationAvatar
Select avatar based on configuration Returns the selected avatar or null if no avatars available
Parameters
- avatars: OrganizationAvatar[]
- Optionaloptions: { avatarId?: string; avatarSelection?: string }
Returns null | OrganizationAvatar
- Defined in packages/core/src/interfaces/IOrganizationService.ts:56