PlatformService Interface Reference

Public Member Functions
proto native bool	FilterProfanityAsync (array< string > textsToFilter, ProfanityFilterRequestCallback callback)
	Requests profanity filtering on the provided texts.
proto native bool	GetPrivilegeAsync (UserPrivilege privilege, PlatformRequestCallback callback)
	Requests privilege from platform.
proto native bool	GetPrivilege (UserPrivilege privilege)
	Checks for given user privilege without invoking any UI.
proto native void	OpenBrowser (string url)
	Open native web browser on specified url.
proto native PlatformKind	GetLocalPlatformKind ()
	Returns.
proto native bool	StartSingleplayerActivity (string ObjectID)
	Start platform specific activity.
proto native bool	EndSingleplayerActivity (string ObjectID, string Outcome)
	End platform specific activity.
proto native bool	ChangeAvailabilitySingleplayerActivity (array< string > activities, array< string > removeActivities)
	Change avilability of platform specific activity.

Member Function Documentation

ChangeAvailabilitySingleplayerActivity()

proto native bool PlatformService.ChangeAvailabilitySingleplayerActivity	(	array< string >	activities,
		array< string >	removeActivities )

Change avilability of platform specific activity.

Parameters

activities

array of activity ids

Returns

Returns true if activity successfully started

EndSingleplayerActivity()

proto native bool PlatformService.EndSingleplayerActivity	(	string	ObjectID,
		string	Outcome )

End platform specific activity.

Parameters

activity	SingleplayerActivity struct.
outcome	Outcome of activity notstarted/inprogress/completed

Returns

Returns true if activity successfully started

FilterProfanityAsync()

proto native bool PlatformService.FilterProfanityAsync	(	array< string >	textsToFilter,
		ProfanityFilterRequestCallback	callback )

Requests profanity filtering on the provided texts.

Parameters

[in]	textsToFilter	Array of strings on which profanity filtering is being requested.
	callback	Callback object used to notify result.

Returns

Returns true if the request is submitted.

GetLocalPlatformKind()

proto native PlatformKind PlatformService.GetLocalPlatformKind

(

)

Returns.

See also

PlatformKind for this particular executable.

GetPrivilege()

proto native bool PlatformService.GetPrivilege

(

UserPrivilege

privilege

)

Checks for given user privilege without invoking any UI.

Parameters

[privilege]

Requested privilege

Returns

Returns true if the privilege is granted

GetPrivilegeAsync()

proto native bool PlatformService.GetPrivilegeAsync	(	UserPrivilege	privilege,
		PlatformRequestCallback	callback )

Requests privilege from platform.

Implemented as queue. When the result for one type of privilege is received, all requests of that type receive the result.

Parameters

[privilege]	Requested privilege
[callback]	Callback object used to signalize result

Returns

Returns if the request was successfully queued

OpenBrowser()

proto native void PlatformService.OpenBrowser

(

string

url

)

Open native web browser on specified url.

StartSingleplayerActivity()

proto native bool PlatformService.StartSingleplayerActivity

(

string

ObjectID

)

Start platform specific activity.

Parameters

activity

SingleplayerActivity struct.

Returns

Returns true if activity successfully started

---

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

• GameLib/platform/PlatformService.c