Enumeration

PurplePresencePrimitive

since: 3.0

Declaration

enum Purple.PresencePrimitive

Description [src]

An enum that is used to determine the type of a PurplePresence.

Available since: 3.0

Members

Name Description
PURPLE_PRESENCE_PRIMITIVE_OFFLINE

The presence is offline or otherwise unknown.

PURPLE_PRESENCE_PRIMITIVE_AVAILABLE

The presence is online or available.

PURPLE_PRESENCE_PRIMITIVE_IDLE

The presence is online but is idle. This state is typically set by the client directly and not the user.

PURPLE_PRESENCE_PRIMITIVE_INVISIBLE

The presence is online, but not visible to others.

PURPLE_PRESENCE_PRIMITIVE_AWAY

The presence is online, but the user is away from their device.

PURPLE_PRESENCE_PRIMITIVE_DO_NOT_DISTURB

Similar to PURPLE_PRESENCE_PRIMITIVE_AWAY, but typically means the user has notifications and sounds disabled.

PURPLE_PRESENCE_PRIMITIVE_STREAMING

The presence is online but is streaming.

Type functions

purple_presence_primitive_to_string

Gets a string representation for primitive that is suitable for display to users.

since: 3.0