IPWorks IoT 2020 JavaScript Edition

Questions / Feedback?

ChangePresence Method

This method will set the availability and status of this entity.


async xmpp.changePresence(presenceCode : number, status : string): Promise<void>


PresenceCode should correspond the possible values of the Presence property:

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

By default, the class sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the class set Presence to the desired presence before calling Connect.

Note: offline is not officially supported by the XMPP specification, however some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

Status can be any random string, including the empty string "".

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 JavaScript Edition - Version 20.0 [Build 8265]