Class PresenceService

Hierarchy

  • PresenceService

Constructors

constructor

Properties

event$ wacRequest

Methods

get$ getAll$ subscribeToPresence$ subscribeToPresences$ unsubscribeFromPresence$ update$

Constructors

constructor

Properties

Readonly event$

event$: Observable<PresenceEvent>

Private wacRequest

wacRequest: WacRequest

Methods

get$

  • get$(address: string): Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>>

  • Get the presence associated with given address

    Parameters

    • address: string

    Returns Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>>

getAll$

  • getAll$(withoutAvatar?: boolean): Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>[]>

  • Returns the list of presences that we are currently subscribed to

    Parameters

    • withoutAvatar: boolean = false

    Returns Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>[]>

subscribeToPresence$

  • subscribeToPresence$(address: string): Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>>

  • Subscribe to user's presence updates

    Parameters

    • address: string

    Returns Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>>

subscribeToPresences$

  • subscribeToPresences$(addresses: string[]): Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>[]>

  • Subscribe to presence updates for the specified addresses

    Parameters

    • addresses: string[]

    Returns Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>[]>

unsubscribeFromPresence$

update$

  • update$(address: string, presence: Partial<PresenceDtoUpdate>): Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>>

  • Updates the presence associated with given address

    Parameters

    Returns Observable<Readonly<{
        activity: PresenceActivity;
        address: string;
        avatar: string;
        displayName: string;
        domain: string;
        id: string;
        mood: PresenceMood;
        note: string;
        online: boolean;
        role: "user" | "anonymous";
        username: string;
    }>>

Settings

Member Visibility

Theme

Generated using TypeDoc