Dragengine.Services.ServiceModio Class Reference

Service providing access to Mod.io functionality if supported. More...

Inheritance diagram for Dragengine.Services.ServiceModio:

Classes
class	InitParameters
	Service initialization parameters. More...
enum	Portal
	Store portal for use with ServiceModio. More...

Public Member Functions
void	activateMods ()
void	addModsListener (ServiceModsListener listener)
void	addUserListener (ServiceUserListener listener)
void	dispose ()
	Dispose of ModIO service.
Dictionary	getActiveMods ()
void	getAuthToken (ServiceUserListener listener)
BaseServiceConversions	getConversions ()
	Conversion helper.
ServiceModProgress	getCurrentModUpdate ()
void	getModInfo (String id, ServiceModsListener listener)
ServiceModsFeatures	getModsFeatures ()
bool	getPauseModManagement ()
Dictionary	getSubscribedMods ()
Dictionary	getSystemMods ()
ServiceUserFeatures	getUserFeatures ()
void	getUserInfo (ServiceUserListener listener)
void	getUserWalletBalance (ServiceUserListener listener)
Boolean	isInitialized ()
	Determines if service is initialized and ready to be used.
bool	isModManagementBusy ()
bool	isUserLoggedIn ()
void	listAllMods (ServiceModFilter filter, ServiceModsListener listener)
void	loadModResource (String url, ServiceModsListener listener)
void	loginUser (ServiceUserCredentials credentials, ServiceUserListener listener)
ServiceModio	new (InitParameters params, ServiceInitListener listener)
	Create service ServiceModIO.
void	purchaseMod (String id, String price, ServiceModsListener listener)
void	removeModsListener (ServiceModsListener listener)
void	removeUserListener (ServiceUserListener listener)
void	reportMod (String id, ServiceModReport report, ServiceModsListener listener)
void	requestResponse (Service service, UniqueID id, ServiceObject response, bool finished)
	Response received for request.
void	revokeModRating (String id, ServiceModsListener listener)
void	setModDisabled (String id, bool disabled, ServiceModsListener listener)
void	setPauseModManagement (bool pause)
void	submitModRating (String id, int rating, ServiceModsListener listener)
void	subscribeMod (String id, ServiceModsListener listener)
void	unsubscribeMod (String id, ServiceModsListener listener)
Public Member Functions inherited from Dragengine.ServiceListener
void	eventReceived (Service service, ServiceObject event)
	Service event received for example notifications.
void	requestFailed (Service service, UniqueID id, ServiceObject error)
	Request failed.

Static Public Member Functions
static bool	isServiceSupported ()
	Checks if ModIO service is supported.

Public Attributes
BaseServiceConversions	pConversions
ServiceInitListener	pInitListener
InitParameters	pInitParameters
Boolean	pIsInitialized
bool	pIsManagementBusy
SafeArray	pModsListeners
Dictionary	pOnceListeners
bool	pPauseManagement
Portal	pPortal
Service	pService

Detailed Description

Service providing access to Mod.io functionality if supported.

Version

1.23

Provides access to these functionalities:

• Mod browsing
• Mod installing
• Mod deinstalling

Member Function Documentation

activateMods()

void Dragengine.Services.ServiceModio.activateMods

(

)

addModsListener()

void Dragengine.Services.ServiceModio.addModsListener

(

ServiceModsListener

listener

)

addUserListener()

void Dragengine.Services.ServiceModio.addUserListener

(

ServiceUserListener

listener

)

dispose()

void Dragengine.Services.ServiceModio.dispose

(

)

Dispose of ModIO service.

getActiveMods()

Dictionary Dragengine.Services.ServiceModio.getActiveMods

(

)

getAuthToken()

void Dragengine.Services.ServiceModio.getAuthToken

(

ServiceUserListener

listener

)

getConversions()

BaseServiceConversions Dragengine.Services.ServiceModio.getConversions

(

)

Conversion helper.

getCurrentModUpdate()

ServiceModProgress Dragengine.Services.ServiceModio.getCurrentModUpdate

(

)

getModInfo()

void Dragengine.Services.ServiceModio.getModInfo	(	String	id,
		ServiceModsListener	listener
	)

getModsFeatures()

ServiceModsFeatures Dragengine.Services.ServiceModio.getModsFeatures

(

)

getPauseModManagement()

bool Dragengine.Services.ServiceModio.getPauseModManagement

(

)

getSubscribedMods()

Dictionary Dragengine.Services.ServiceModio.getSubscribedMods

(

)

getSystemMods()

Dictionary Dragengine.Services.ServiceModio.getSystemMods

(

)

getUserFeatures()

ServiceUserFeatures Dragengine.Services.ServiceModio.getUserFeatures

(

)

getUserInfo()

void Dragengine.Services.ServiceModio.getUserInfo

(

ServiceUserListener

listener

)

getUserWalletBalance()

void Dragengine.Services.ServiceModio.getUserWalletBalance

(

ServiceUserListener

listener

)

isInitialized()

Boolean Dragengine.Services.ServiceModio.isInitialized

(

)

Determines if service is initialized and ready to be used.

If null is returned the service is still initializing. If returned object has true value the service is initialized and ready to be used. If returned object has false value the service failed to initialized and has to be disposed.

isModManagementBusy()

bool Dragengine.Services.ServiceModio.isModManagementBusy

(

)

isServiceSupported()

static bool Dragengine.Services.ServiceModio.isServiceSupported ( )

static

Checks if ModIO service is supported.

Service is reported supported if the ModIO Service Module is present. Creating the service can still fail.

isUserLoggedIn()

bool Dragengine.Services.ServiceModio.isUserLoggedIn

(

)

listAllMods()

void Dragengine.Services.ServiceModio.listAllMods	(	ServiceModFilter	filter,
		ServiceModsListener	listener
	)

loadModResource()

void Dragengine.Services.ServiceModio.loadModResource	(	String	url,
		ServiceModsListener	listener
	)

loginUser()

void Dragengine.Services.ServiceModio.loginUser	(	ServiceUserCredentials	credentials,
		ServiceUserListener	listener
	)

new()

ServiceModio Dragengine.Services.ServiceModio.new	(	InitParameters	params,
		ServiceInitListener	listener
	)

Create service ServiceModIO.

The service is asynchronously initialized. Once initialization finished the provided listener is called with success or failure outcome. If the outcome is success the service can be used. If the outcome is failure the service can not be used and should be disposed.

Parameters

params	Init parameters.
listener	Listener called if initialization finished. Can be null.

Exceptions

EInvalidParam	ModIO service module is not present.
EInvalidParam	One or more of the provided parameters is not valid.

purchaseMod()

void Dragengine.Services.ServiceModio.purchaseMod	(	String	id,
		String	price,
		ServiceModsListener	listener
	)

removeModsListener()

void Dragengine.Services.ServiceModio.removeModsListener

(

ServiceModsListener

listener

)

removeUserListener()

void Dragengine.Services.ServiceModio.removeUserListener

(

ServiceUserListener

listener

)

reportMod()

void Dragengine.Services.ServiceModio.reportMod	(	String	id,
		ServiceModReport	report,
		ServiceModsListener	listener
	)

requestResponse()

void Dragengine.Services.ServiceModio.requestResponse	(	Service	service,
		UniqueID	id,
		ServiceObject	response,
		bool	finished
	)

Response received for request.

Parameters

service	Service receiving the response.
id	Identifier of request this response belongs to.
response	Response data.
finished	True if the request finished or false if more responses will be received.

Implements Dragengine.ServiceListener.

revokeModRating()

void Dragengine.Services.ServiceModio.revokeModRating	(	String	id,
		ServiceModsListener	listener
	)

setModDisabled()

void Dragengine.Services.ServiceModio.setModDisabled	(	String	id,
		bool	disabled,
		ServiceModsListener	listener
	)

setPauseModManagement()

void Dragengine.Services.ServiceModio.setPauseModManagement

(

bool

pause

)

submitModRating()

void Dragengine.Services.ServiceModio.submitModRating	(	String	id,
		int	rating,
		ServiceModsListener	listener
	)

subscribeMod()

void Dragengine.Services.ServiceModio.subscribeMod	(	String	id,
		ServiceModsListener	listener
	)

unsubscribeMod()

void Dragengine.Services.ServiceModio.unsubscribeMod	(	String	id,
		ServiceModsListener	listener
	)

Member Data Documentation

pConversions

BaseServiceConversions Dragengine.Services.ServiceModio.pConversions

pInitListener

ServiceInitListener Dragengine.Services.ServiceModio.pInitListener

pInitParameters

InitParameters Dragengine.Services.ServiceModio.pInitParameters

pIsInitialized

Boolean Dragengine.Services.ServiceModio.pIsInitialized

pIsManagementBusy

bool Dragengine.Services.ServiceModio.pIsManagementBusy

pModsListeners

SafeArray Dragengine.Services.ServiceModio.pModsListeners

pOnceListeners

Dictionary Dragengine.Services.ServiceModio.pOnceListeners

pPauseManagement

bool Dragengine.Services.ServiceModio.pPauseManagement

pPortal

Portal Dragengine.Services.ServiceModio.pPortal

pService

Service Dragengine.Services.ServiceModio.pService

---

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

• ServiceModio.ds