PresencePerson

public class PresencePerson : LinphoneObject

Presence person holding information about a presence person.

  • Undocumented

    Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> PresencePerson
  • Undocumented

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • id

    Sets the id of a presence person.

    Declaration

    Swift

    public var id: String { get }

    Parameters

    id

    The id string to set. Can be nil to generate it automatically.

    Return Value

    A pointer to a dynamically allocated string containing the id, or nil in case of error.
    The returned string is to be freed by calling ms_free().

  • Undocumented

    Declaration

    Swift

    public func setId(newValue: String) throws
  • Gets the number of activities included in the presence person.

    Declaration

    Swift

    public var nbActivities: UInt { get }

    Return Value

    The number of activities included in the PresencePerson object.

  • Gets the number of activities notes included in the presence person.

    Declaration

    Swift

    public var nbActivitiesNotes: UInt { get }

    Return Value

    The number of activities notes included in the PresencePerson object.

  • Gets the number of notes included in the presence person.

    Declaration

    Swift

    public var nbNotes: UInt { get }

    Return Value

    The number of notes included in the PresencePerson object.

  • Sets the user data of a PresencePerson object.

    Declaration

    Swift

    public var userData: UnsafeMutableRawPointer? { get set }

    Parameters

    userData

    A pointer to the user data to set.
    Gets the user data of a PresencePerson object.

    Return Value

    A pointer to the user data.

  • Adds an activities note to a presence person.

    Declaration

    Swift

    public func addActivitiesNote(note: PresenceNote) throws

    Parameters

    note

    The PresenceNote object to add to the person.

    Return Value

    0 if successful, a value < 0 in case of error.

  • Adds an activity to a presence person.

    Declaration

    Swift

    public func addActivity(activity: PresenceActivity) throws

    Parameters

    activity

    The PresenceActivity object to add to the person.

    Return Value

    0 if successful, a value < 0 in case of error.

  • Adds a note to a presence person.

    Declaration

    Swift

    public func addNote(note: PresenceNote) throws

    Parameters

    note

    The PresenceNote object to add to the person.

    Return Value

    0 if successful, a value < 0 in case of error.

  • Clears the activities of a presence person.

    Declaration

    Swift

    public func clearActivities() throws

    Return Value

    0 if successful, a value < 0 in case of error.

  • Clears the activities notes of a presence person.

    Declaration

    Swift

    public func clearActivitiesNotes() throws

    Return Value

    0 if successful, a value < 0 in case of error.

  • Clears the notes of a presence person.

    Declaration

    Swift

    public func clearNotes() throws

    Return Value

    0 if successful, a value < 0 in case of error.

  • Gets the nth activities note of a presence person.

    Declaration

    Swift

    public func getNthActivitiesNote(index: UInt) -> PresenceNote?

    Parameters

    index

    The index of the activities note to get (the first note having the index 0).

    Return Value

    A pointer to a PresenceNote object if successful, nil otherwise.

  • Gets the nth activity of a presence person.

    Declaration

    Swift

    public func getNthActivity(index: UInt) -> PresenceActivity?

    Parameters

    index

    The index of the activity to get (the first activity having the index 0).

    Return Value

    A pointer to a PresenceActivity object if successful, nil otherwise.

  • Gets the nth note of a presence person.

    Declaration

    Swift

    public func getNthNote(index: UInt) -> PresenceNote?

    Parameters

    index

    The index of the note to get (the first note having the index 0).

    Return Value

    A pointer to a PresenceNote object if successful, nil otherwise.