Enumeration
PurplePresencePrimitive
unstable since: 3.0
Description [src]
An enum that is used to determine the type of a PurplePresence.
Available since: 3.0
Members
-
PURPLE_PRESENCE_PRIMITIVE_OFFLINE -
The presence is offline or otherwise unknown.
- Value:
0 - Available since: 3.0
- Value:
-
PURPLE_PRESENCE_PRIMITIVE_AVAILABLE -
The presence is online or available.
- Value:
1 - Available since: 3.0
- Value:
-
PURPLE_PRESENCE_PRIMITIVE_IDLE -
The presence is online but is idle. This state is typically set by the client directly and not the user.
- Value:
2 - Available since: 3.0
- Value:
-
PURPLE_PRESENCE_PRIMITIVE_INVISIBLE -
The presence is online, but not visible to others.
- Value:
3 - Available since: 3.0
- Value:
-
PURPLE_PRESENCE_PRIMITIVE_AWAY -
The presence is online, but the user is away from their device.
- Value:
4 - Available since: 3.0
- Value:
-
PURPLE_PRESENCE_PRIMITIVE_DO_NOT_DISTURB -
Similar to
PURPLE_PRESENCE_PRIMITIVE_AWAY, but typically means the user has notifications and sounds disabled.- Value:
5 - Available since: 3.0
- Value:
-
PURPLE_PRESENCE_PRIMITIVE_STREAMING -
The presence is online but is streaming.
- Value:
6 - Available since: 3.0
- Value:
Type functions
purple_presence_primitive_to_string
Gets a string representation for primitive that is suitable for display to users.
unstable since: 3.0