SetStatus Method
      
 

Description

Changes user's status.


Return Type

None  


Syntax

object.SetStatus NewStatus, [Description]



The SetStatus Method syntax has these parts:

Part Description
object An expression evaluating to an object of type wodXMPP.
NewStatus Required. A StatusEnum enumeration, as described in settings.
Description Optional. A Variant value. String value, describing the new status.

Settings

The settings for NewStatus are:

Constant Value Description
 Offline 0 Offline.
 Online 1 Online.
 Away 2 Away.
 Chat 3 Free for chat.
 DoNotDisturb 4 Do not disturb.
 ExtendedAway 5 Extended away.
 Invisible 6 Invisible.
 Requested 7 Asking for subscription.
 Unsubscribed 8 Contact not subscribed.

Remarks

Use this method to change user's status. Method accepts NewStatus parameter, and an optional, Description parameter. Depending on the parameters you provide to the method, you can set, or even create custom description texts. If you set Description, it will be shown to your contacts instead of default description (such as 'Away', 'Free for chat' etc..)