PresenceService

public class PresenceService : LinphoneObject

Presence service type holding information about a presence service.

  • Undocumented

    Declaration

    Swift

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

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • Sets the basic status of a presence service.

    Declaration

    Swift

    public var basicStatus: PresenceBasicStatus { get }

    Parameters

    basicStatus

    The PresenceBasicStatus to set for the PresenceService object.

    Return Value

    The PresenceBasicStatus of the PresenceService object given as parameter.

  • Undocumented

    Declaration

    Swift

    public func setBasicstatus(newValue: PresenceBasicStatus) throws
  • Sets the contact of a presence service.

    Declaration

    Swift

    public var contact: String { get }

    Parameters

    contact

    The contact string to set.

    Return Value

    A pointer to a dynamically allocated string containing the contact, or nil if no contact is found.
    The returned string is to be freed by calling ms_free().

  • Undocumented

    Declaration

    Swift

    public func setContact(newValue: String) throws
  • id

    Sets the id of a presence service.

    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 notes included in the presence service.

    Declaration

    Swift

    public var nbNotes: UInt { get }

    Return Value

    The number of notes included in the PresenceService object.

  • Sets the service descriptions of a presence service.

    Declaration

    Swift

    public var serviceDescriptions: [String] { get }

    Parameters

    descriptions

    The service descriptions.

    Return Value

    A containing the services descriptions.
    The returned string is to be freed.

  • Undocumented

    Declaration

    Swift

    public func setServicedescriptions(newValue: [String]) throws
  • Sets the user data of a PresenceService 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 PresenceService object.

    Return Value

    A pointer to the user data.

  • Adds a note to a presence service.

    Declaration

    Swift

    public func addNote(note: PresenceNote) throws

    Parameters

    note

    The PresenceNote object to add to the service.

    Return Value

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

  • Clears the notes of a presence service.

    Declaration

    Swift

    public func clearNotes() throws

    Return Value

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

  • Gets the nth note of a presence service.

    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.