Home Reference Source
import {Presence} from '@quobis/sippojs'
public class | source

Presence

Extends:

src/eventemitter.js~EventEmitter → Presence

Direct Subclass:

OwnPresence

This class must not be instantiated. Presence objects are automatically obtained associated to Contact objects.

Events

  • update -> triggered every time the presence object is updated.

Constructor Summary

Public Constructor
public

constructor(presenceManager: PresenceManager, address: string)

Member Summary

Public Members
public get
this get was deprecated. Use "import {PresenceActivity} from '@quobis/sippojs' instead"

Represents the different status of an user

public get
this get was deprecated. Use "import {PresenceMood} from '@quobis/sippojs' instead"

Represents the different emotional states of an user

public get

User activity

public get

Address associated with this presence

public set

Update address associated with this presence

public get

Avatar location

public get

Display name

public get

User emotional state

public get

Short message defined by user

public get

User is online

Method Summary

Public Methods
public

Returns a JSON representation of the object.

public

Public Constructors

public constructor(presenceManager: PresenceManager, address: string) source

Params:

NameTypeAttributeDescription
presenceManager PresenceManager
address string

Public Members

public get ACTIVITY: Enum<PresenceActivity> source

this get was deprecated. Use "import {PresenceActivity} from '@quobis/sippojs' instead"

Represents the different status of an user

public get MOOD: Enum<PresenceMood> source

this get was deprecated. Use "import {PresenceMood} from '@quobis/sippojs' instead"

Represents the different emotional states of an user

public get activity: PresenceActivity source

User activity

public get address: String source

Address associated with this presence

public set address: String source

Update address associated with this presence

public get avatar: String source

Avatar location

public get displayName: String source

Display name

public get mood: PresenceMood source

User emotional state

public get note: String source

Short message defined by user

public get online: boolean source

User is online

Public Methods

public toJSON(): Object source

Returns a JSON representation of the object.

Return:

Object

Return Properties:

NameTypeAttributeDescription
online boolean
activity string
mood string
note string
avatar string
displayName string

public waitUntilSynced(): Promise<void> source

Return:

Promise<void>