events.load()

Type Function
Return value none
Revision Release 2024.3703
Keywords Google Play Games Services, game network, gpgs, events, load
See also gpgs.events
gpgs.*

Overview

Retrieves information on all events available in the game.

Syntax

gpgs.events.load( params )
params (required)

Table. Contains parameters for the call — see the next section for details.

Parameter Reference

The params table contains parameters for the call.

eventId (optional)

String. If provided, loads only this event information. If omitted, all events will be loaded.

eventIds (optional)

Array. Populate with string elements to load information on each specified event. If provided, this has higher priority than eventId.

reload (optional)

Boolean. If true, the data will be retrieved fresh, not from a cache.

listener (optional)

Listener. Listener function which receives a load event.