NotificationInfo Interface Reference

Inheritance diagram for NotificationInfo:

Public Member Functions
proto external int	GetId ()
	Can be used as a filter for listing notifications with ID greater than a specific value and to delete / mark as read.
proto external bool	IsMarkedAsRead ()
proto external string	GetType ()
	Returns type of the notification.
proto external string	GetCategory ()
	Returns category of the notification.
proto external string	GetSourceType ()
	Returns type of the source of the notification.
proto external UUID	GetSourceUserGameIdentity ()
	Returns game identity of the source user of this notification.
proto external void	ExpandPayload (JsonApiStruct pPayload)
	Expand payload of the notification.
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Member Function Documentation

ExpandPayload()

proto external void NotificationInfo.ExpandPayload

(

JsonApiStruct

pPayload

)

Expand payload of the notification.

The payload's structure is determined by the notification's type.

Note

Given JsonApiStruct must match the expected structure of the payload.

GetCategory()

proto external string NotificationInfo.GetCategory

(

)

Returns category of the notification.

GetId()

proto external int NotificationInfo.GetId

(

)

Can be used as a filter for listing notifications with ID greater than a specific value and to delete / mark as read.

GetSourceType()

proto external string NotificationInfo.GetSourceType

(

)

Returns type of the source of the notification.

GetSourceUserGameIdentity()

proto external UUID NotificationInfo.GetSourceUserGameIdentity

(

)

Returns game identity of the source user of this notification.

Note

Can be null if the source is not a user.

GetType()

proto external string NotificationInfo.GetType

(

)

Returns type of the notification.

Note

Type of the notification determines structure of the payload.

IsMarkedAsRead()

proto external bool NotificationInfo.IsMarkedAsRead

(

)

---

The documentation for this interface was generated from the following file:

• GameLib/generated/online/notifications/NotificationInfo.c