External: LinphonePresenceModel

LinphonePresenceModel

Presence model type holding information about the presence of a person.
Source:

Members

<readonly> activity :external:LinphonePresenceActivity

Gets the first activity of a presence model (there is usually only one).
Type:
Source:

basicStatus :linphone.PresenceBasicStatus

Sets the basic status of a presence model.
Type:
Source:

contact :string

Sets the contact of a presence model.
Type:
  • string
Source:

<readonly> nbActivities :number

Gets the number of activities included in the presence model.
Type:
  • number
Source:

<readonly> nbPersons :number

Gets the number of persons included in the presence model.
Type:
  • number
Source:

<readonly> nbServices :number

Gets the number of services included in the presence model.
Type:
  • number
Source:

<readonly> timestamp :external:time_t

Gets the timestamp of a presence model.
Type:
  • external:time_t
Source:

Methods

addActivity(activity) → {number}

Adds an activity to a presence model.
Parameters:
Name Type Description
activity external:LinphonePresenceActivity The
Source:
Returns:
Type
number

addNote(note_content, lang) → {number}

Adds a note to a presence model.
Parameters:
Name Type Description
note_content string The note to be added to the presence model.
lang string The language of the note to be added. Can be NULL if no language is to be specified for the note.
Source:
Returns:
Type
number

addPerson(person) → {number}

Adds a person to a presence model.
Parameters:
Name Type Description
person external:LinphonePresencePerson The
Source:
Returns:
Type
number

addService(service) → {number}

Adds a service to a presence model.
Parameters:
Name Type Description
service external:LinphonePresenceService The
Source:
Returns:
Type
number

clearActivities() → {number}

Clears the activities of a presence model.
Source:
Returns:
Type
number

clearNotes() → {number}

Clears all the notes of a presence model.
Source:
Returns:
Type
number

clearPersons() → {number}

Clears the persons of a presence model.
Source:
Returns:
Type
number

clearServices() → {number}

Clears the services of a presence model.
Source:
Returns:
Type
number

getNote(lang) → {external:LinphonePresenceNote}

Gets the first note of a presence model (there is usually only one).
Parameters:
Name Type Description
lang string The language of the note to get. Can be NULL to get a note that has no language specified or to get the first note whatever language it is written into.
Source:
Returns:
Type
external:LinphonePresenceNote

getNthActivity(idx) → {external:LinphonePresenceActivity}

Gets the nth activity of a presence model.
Parameters:
Name Type Description
idx number The index of the activity to get (the first activity having the index 0).
Source:
Returns:
Type
external:LinphonePresenceActivity

getNthPerson(idx) → {external:LinphonePresencePerson}

Gets the nth person of a presence model.
Parameters:
Name Type Description
idx number The index of the person to get (the first person having the index 0).
Source:
Returns:
Type
external:LinphonePresencePerson

getNthService(idx) → {external:LinphonePresenceService}

Gets the nth service of a presence model.
Parameters:
Name Type Description
idx number The index of the service to get (the first service having the index 0).
Source:
Returns:
Type
external:LinphonePresenceService

setActivity(activity, description) → {number}

Sets the activity of a presence model (limits to only one activity).
Parameters:
Name Type Description
activity linphone.PresenceActivityType The
description string An additional description of the activity to set for the model. Can be NULL if no additional description is to be added.
Source:
Returns:
Type
number