[−][src]Trait subor_rs::brain_cloud_service_s_d_k_services::BrainCloudServiceSyncHandler
Required methods
fn handle_async_match_create_match(
&self,
json_opponent_ids: String,
push_notification_message: String,
client_index: i32
) -> Result<String>
&self,
json_opponent_ids: String,
push_notification_message: String,
client_index: i32
) -> Result<String>
Creates an instance of an asynchronous match.
fn handle_async_match_create_match_with_initial_turn(
&self,
json_opponent_ids: String,
json_match_state: String,
push_notification_message: String,
next_player: String,
json_summary: String,
client_index: i32
) -> Result<String>
&self,
json_opponent_ids: String,
json_match_state: String,
push_notification_message: String,
next_player: String,
json_summary: String,
client_index: i32
) -> Result<String>
Creates an instance of an asynchronous match with an initial turn.
fn handle_async_match_submit_turn(
&self,
owner_id: String,
match_id: String,
version: i64,
json_match_state: String,
push_notification_message: String,
next_player: String,
json_summary: String,
json_statistics: String,
client_index: i32
) -> Result<String>
&self,
owner_id: String,
match_id: String,
version: i64,
json_match_state: String,
push_notification_message: String,
next_player: String,
json_summary: String,
json_statistics: String,
client_index: i32
) -> Result<String>
Submits a turn for the given match.
fn handle_async_match_update_match_summary_data(
&self,
owner_id: String,
match_id: String,
version: i64,
json_summary: String,
client_index: i32
) -> Result<String>
&self,
owner_id: String,
match_id: String,
version: i64,
json_summary: String,
client_index: i32
) -> Result<String>
Allows the current player (only) to update Summary data without having to submit a whole turn.
fn handle_async_match_complete_match(
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
Marks the given match as complete.
fn handle_async_match_read_match(
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
Returns the current state of the given match.
fn handle_async_match_read_match_history(
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
Returns the match history of the given match.
fn handle_async_match_find_matches(&self, client_index: i32) -> Result<String>
Returns all matches that are NOT in a COMPLETE state for which the player is involved.
fn handle_async_match_find_complete_matches(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Returns all matches that are in a COMPLETE state for which the player is involved.
fn handle_async_match_abandon_match(
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
Marks the given match as abandoned.
fn handle_async_match_delete_match(
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
&self,
owner_id: String,
match_id: String,
client_index: i32
) -> Result<String>
Removes the match and match history from the server. DEBUG ONLY, in production it is recommended the user leave it as completed.
fn handle_authentication_generate_anonymous_id(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Used to create the anonymous installation id for the brainCloud profile.
fn handle_authentication_initialize(
&self,
profile_id: String,
anonymous_id: String,
client_index: i32
) -> Result<()>
&self,
profile_id: String,
anonymous_id: String,
client_index: i32
) -> Result<()>
Initialize - initializes the identity service with a saved anonymous installation id and most recently used profile id
fn handle_authentication_clear_saved_profile_i_d(
&self,
client_index: i32
) -> Result<()>
&self,
client_index: i32
) -> Result<()>
Used to clear the saved profile id - to use in cases when the user is attempting to switch to a different app profile.
fn handle_authentication_authenticate_anonymous(
&self,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
force_create: bool,
client_index: i32
) -> Result<String>
Authenticate a user anonymously with brainCloud - used for apps that don't want to bother the user to login, or for users who are sensitive to their privacy
fn handle_authentication_authenticate_email_password(
&self,
email: String,
password: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
email: String,
password: String,
force_create: bool,
client_index: i32
) -> Result<String>
Authenticate the user with a custom Email and Password. Note that the client app is responsible for collecting (and storing) the e-mail and potentially password (for convenience) in the client data. For the greatest security, force the user to re-enter their password at each login. (Or at least give them that option).
fn handle_authentication_authenticate_universal(
&self,
user_id: String,
password: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
user_id: String,
password: String,
force_create: bool,
client_index: i32
) -> Result<String>
Authenticate the user using a userId and password (without any validation on the userId). Similar to AuthenticateEmailPassword - except that that method has additional features to allow for e-mail validation, password resets, etc.
fn handle_authentication_authenticate_external(
&self,
user_id: String,
token: String,
external_auth_name: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
user_id: String,
token: String,
external_auth_name: String,
force_create: bool,
client_index: i32
) -> Result<String>
Authenticate the user via cloud code (which in turn validates the supplied credentials against an external system). This allows the developer to extend brainCloud authentication to support other backend authentication systems.
fn handle_authentication_authenticate_phone(
&self,
phone_number: String,
auth_code: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
phone_number: String,
auth_code: String,
force_create: bool,
client_index: i32
) -> Result<String>
Authenticate the user via wechat
fn handle_authentication_authenticate_wechat(
&self,
open_id: String,
token: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
open_id: String,
token: String,
force_create: bool,
client_index: i32
) -> Result<String>
Authenticate the user via wechat
fn handle_authentication_reset_email_password(
&self,
external_id: String,
client_index: i32
) -> Result<String>
&self,
external_id: String,
client_index: i32
) -> Result<String>
Reset Email password - Sends a password reset email to the specified address
fn handle_authentication_request_sms_code(
&self,
phone_number: String,
force_create: bool,
is_international: bool,
client_index: i32
) -> Result<String>
&self,
phone_number: String,
force_create: bool,
is_international: bool,
client_index: i32
) -> Result<String>
Request an SMS code sent to a phone prior to authentication.
fn handle_authentication_check_username_exists(
&self,
game_id: String,
player_name: String,
client_index: i32
) -> Result<String>
&self,
game_id: String,
player_name: String,
client_index: i32
) -> Result<String>
fn handle_authentication_change_universal_password(
&self,
game_id: String,
player_id: String,
old_password: String,
new_password: String,
client_index: i32
) -> Result<String>
&self,
game_id: String,
player_id: String,
old_password: String,
new_password: String,
client_index: i32
) -> Result<String>
fn handle_client_get_session_id(&self, client_index: i32) -> Result<String>
Returns the sessionId or empty string if no session present.
fn handle_client_is_authenticated(&self, client_index: i32) -> Result<bool>
Returns true if the user is currently authenticated. If a session time out or session invalidation is returned from executing a sever API call, this flag will reset back to false.
fn handle_client_is_initialized(&self, client_index: i32) -> Result<bool>
Returns true if brainCloud has been initialized.
fn handle_client_initialize_s_s_s(
&self,
secret_key: String,
app_id: String,
app_version: String,
client_index: i32
) -> Result<()>
&self,
secret_key: String,
app_id: String,
app_version: String,
client_index: i32
) -> Result<()>
Method initializes the BrainCloudClient.
fn handle_client_initialize_s_s_s_s(
&self,
server_u_r_l: String,
secret_key: String,
app_id: String,
app_version: String,
client_index: i32
) -> Result<()>
&self,
server_u_r_l: String,
secret_key: String,
app_id: String,
app_version: String,
client_index: i32
) -> Result<()>
Method initializes the BrainCloudClient.
fn handle_client_initialize_identity(
&self,
profile_id: String,
anonymous_id: String,
client_index: i32
) -> Result<()>
&self,
profile_id: String,
anonymous_id: String,
client_index: i32
) -> Result<()>
Initialize the identity aspects of brainCloud.
fn handle_client_update(&self, client_index: i32) -> Result<()>
Update method needs to be called regularly in order to process incoming and outgoing messages.
fn handle_client_enable_logging(
&self,
enable: bool,
client_index: i32
) -> Result<()>
&self,
enable: bool,
client_index: i32
) -> Result<()>
Enable logging of brainCloud transactions (comms etc)
fn handle_client_reset_communication(&self, client_index: i32) -> Result<()>
Resets all messages and calls to the server
fn handle_client_set_packet_timeouts(
&self,
timeouts: Vec<i32>,
client_index: i32
) -> Result<()>
&self,
timeouts: Vec<i32>,
client_index: i32
) -> Result<()>
Sets the packet timeouts using a list of integers that represent timeout values for each packet retry. The first item in the list represents the timeout for the first packet attempt, the second for the second packet attempt, and so on.
The number of entries in this array determines how many packet retries will occur.
By default, the packet timeout array is {10, 10, 10}
Note that this method does not change the timeout for authentication packets (use SetAuthenticationPacketTimeout method).
fn handle_client_set_packet_timeouts_to_default(
&self,
client_index: i32
) -> Result<()>
&self,
client_index: i32
) -> Result<()>
Sets the packet timeouts back to default.
fn handle_client_get_packet_timeouts(
&self,
client_index: i32
) -> Result<Vec<i32>>
&self,
client_index: i32
) -> Result<Vec<i32>>
Returns the list of packet timeouts.
fn handle_client_set_authentication_packet_timeout(
&self,
timeout_secs: i32,
client_index: i32
) -> Result<()>
&self,
timeout_secs: i32,
client_index: i32
) -> Result<()>
Sets the authentication packet timeout which is tracked separately from all other packets. Note that authentication packets are never retried and so this value represents the total time a client would wait to receive a reply to an authentication API call. By default this timeout is set to 15 seconds.
fn handle_client_get_authentication_packet_timeout(
&self,
client_index: i32
) -> Result<i32>
&self,
client_index: i32
) -> Result<i32>
Gets the authentication packet timeout which is tracked separately from all other packets. Note that authentication packets are never retried and so this value represents the total time a client would wait to receive a reply to an authentication API call. By default this timeout is set to 15 seconds.
fn handle_client_get_upload_low_transfer_rate_timeout(
&self,
client_index: i32
) -> Result<i32>
&self,
client_index: i32
) -> Result<i32>
Returns the low transfer rate timeout in secs
fn handle_client_set_upload_low_transfer_rate_timeout(
&self,
timeout_secs: i32,
client_index: i32
) -> Result<()>
&self,
timeout_secs: i32,
client_index: i32
) -> Result<()>
Sets the timeout in seconds of a low speed upload (i.e. transfer rate which is underneath the low transfer rate threshold). By default this is set to 120 secs.Setting this value to 0 will turn off the timeout. Note that this timeout method does not work on Unity mobile platforms.
fn handle_client_get_upload_low_transfer_rate_threshold(
&self,
client_index: i32
) -> Result<i32>
&self,
client_index: i32
) -> Result<i32>
Returns the low transfer rate threshold in bytes/sec
fn handle_client_set_upload_low_transfer_rate_threshold(
&self,
bytes_per_sec: i32,
client_index: i32
) -> Result<()>
&self,
bytes_per_sec: i32,
client_index: i32
) -> Result<()>
Sets the low transfer rate threshold of an upload in bytes/sec. If the transfer rate dips below the given threshold longer than the specified timeout, the transfer will fail. By default this is set to 50 bytes/sec. Note that this timeout method does not work on Unity mobile platforms.
fn handle_client_enable_network_error_message_caching(
&self,
enabled: bool,
client_index: i32
) -> Result<()>
&self,
enabled: bool,
client_index: i32
) -> Result<()>
Enables the timeout message caching which is disabled by default. Once enabled, if a client side timeout is encountered (i.e. brainCloud server is unreachable presumably due to the client network being down) the SDK will do the following:
1 - cache the currently queued messages to brainCloud 2 - call the network error callback 3 - then expect the app to call either: a) RetryCachedMessages() to retry sending to brainCloud b) FlushCachedMessages() to dump all messages in the queue.
Between steps 2 and 3, the app can prompt the user to retry connecting to brainCloud to determine whether to follow path 3a or 3b.
Note that if path 3a is followed, and another timeout is encountered, the process will begin all over again from step 1.
WARNING - the brainCloud SDK will cache all API calls sent when a timeout is encountered if this mechanism is enabled. This effectively freezes all communication with brainCloud. Apps must call either RetryCachedMessages() or FlushCachedMessages() for the brainCloud SDK to resume sending messages. ResetCommunication() will also clear the message cache.
fn handle_client_retry_cached_messages(&self, client_index: i32) -> Result<()>
Attempts to resend any cached messages. If no messages are in the cache, this method does nothing.
fn handle_client_flush_cached_messages(
&self,
send_api_error_callbacks: bool,
client_index: i32
) -> Result<()>
&self,
send_api_error_callbacks: bool,
client_index: i32
) -> Result<()>
Flushes the cached messages to resume API call processing. This will dump all of the cached messages in the queue.
fn handle_client_insert_end_of_message_bundle_marker(
&self,
client_index: i32
) -> Result<()>
&self,
client_index: i32
) -> Result<()>
Inserts a marker which will tell the brainCloud comms layer to close the message bundle off at this point. Any messages queued before this method was called will likely be bundled together in the next send to the server.
To ensure that only a single message is sent to the server you would do something like this:
InsertEndOfMessageBundleMarker() SomeApiCall() InsertEndOfMessageBundleMarker()
fn handle_client_override_country_code(
&self,
country_code: String,
client_index: i32
) -> Result<()>
&self,
country_code: String,
client_index: i32
) -> Result<()>
Sets the country code sent to brainCloud when a user authenticates. Will override any auto detected country.
fn handle_client_override_language_code(
&self,
language_code: String,
client_index: i32
) -> Result<()>
&self,
language_code: String,
client_index: i32
) -> Result<()>
Sets the language code sent to brainCloud when a user authenticates. If the language is set to a non-ISO 639-1 standard value the game default will be used instead. Will override any auto detected language.
fn handle_data_stream_custom_page_event(
&self,
event_name: String,
json_event_properties: String,
client_index: i32
) -> Result<String>
&self,
event_name: String,
json_event_properties: String,
client_index: i32
) -> Result<String>
Creates custom data stream page event
fn handle_data_stream_custom_screen_event(
&self,
event_name: String,
json_event_properties: String,
client_index: i32
) -> Result<String>
&self,
event_name: String,
json_event_properties: String,
client_index: i32
) -> Result<String>
Creates custom data stream screen event
fn handle_data_stream_custom_track_event(
&self,
event_name: String,
json_event_properties: String,
client_index: i32
) -> Result<String>
&self,
event_name: String,
json_event_properties: String,
client_index: i32
) -> Result<String>
Creates custom data stream track event
fn handle_entity_create_entity(
&self,
entity_type: String,
json_entity_data: String,
json_entity_acl: String,
client_index: i32
) -> Result<String>
&self,
entity_type: String,
json_entity_data: String,
json_entity_acl: String,
client_index: i32
) -> Result<String>
Method creates a new entity on the server.
fn handle_entity_get_entities_by_type(
&self,
entity_type: String,
client_index: i32
) -> Result<String>
&self,
entity_type: String,
client_index: i32
) -> Result<String>
Method returns all user entities that match the given type.
fn handle_entity_update_entity(
&self,
entity_id: String,
entity_type: String,
json_entity_data: String,
json_entity_acl: String,
version: i32,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
entity_type: String,
json_entity_data: String,
json_entity_acl: String,
version: i32,
client_index: i32
) -> Result<String>
Method updates a new entity on the server. This operation results in the entity data being completely replaced by the passed in JSON string.
fn handle_entity_update_shared_entity(
&self,
entity_id: String,
target_profile_id: String,
entity_type: String,
json_entity_data: String,
version: i32,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
target_profile_id: String,
entity_type: String,
json_entity_data: String,
version: i32,
client_index: i32
) -> Result<String>
Method updates a shared entity owned by another user. This operation results in the entity data being completely replaced by the passed in JSON string.
fn handle_entity_delete_entity(
&self,
entity_id: String,
version: i32,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
version: i32,
client_index: i32
) -> Result<String>
Method deletes the given entity on the server.
fn handle_entity_update_singleton(
&self,
entity_type: String,
json_entity_data: String,
json_entity_acl: String,
version: i32,
client_index: i32
) -> Result<String>
&self,
entity_type: String,
json_entity_data: String,
json_entity_acl: String,
version: i32,
client_index: i32
) -> Result<String>
Method updates a singleton entity on the server. This operation results in the entity data being completely replaced by the passed in JSON string. If the entity doesn't exist it is created.
fn handle_entity_delete_singleton(
&self,
entity_type: String,
version: i32,
client_index: i32
) -> Result<String>
&self,
entity_type: String,
version: i32,
client_index: i32
) -> Result<String>
Method deletes the given singleton on the server.
fn handle_entity_get_entity(
&self,
entity_id: String,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
client_index: i32
) -> Result<String>
Method to get a specific entity.
fn handle_entity_get_singleton(
&self,
entity_type: String,
client_index: i32
) -> Result<String>
&self,
entity_type: String,
client_index: i32
) -> Result<String>
Method retrieves a singleton entity on the server. If the entity doesn't exist, null is returned.
fn handle_entity_get_shared_entity_for_profile_id(
&self,
profile_id: String,
entity_id: String,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
entity_id: String,
client_index: i32
) -> Result<String>
Method returns a shared entity for the given profile and entity ID. An entity is shared if its ACL allows for the currently logged in user to read the data.
fn handle_entity_get_shared_entities_for_profile_id(
&self,
profile_id: String,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
client_index: i32
) -> Result<String>
Method returns all shared entities for the given profile id. An entity is shared if its ACL allows for the currently logged in user to read the data.
fn handle_entity_get_list(
&self,
where_json: String,
order_by_json: String,
max_return: i32,
client_index: i32
) -> Result<String>
&self,
where_json: String,
order_by_json: String,
max_return: i32,
client_index: i32
) -> Result<String>
Method gets list of entities from the server base on type and/or where clause
fn handle_entity_get_shared_entities_list_for_profile_id(
&self,
profile_id: String,
where_json: String,
order_by_json: String,
max_return: i32,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
where_json: String,
order_by_json: String,
max_return: i32,
client_index: i32
) -> Result<String>
Method gets list of shared entities for the specified user based on type and/or where clause
fn handle_entity_get_list_count(
&self,
where_json: String,
client_index: i32
) -> Result<String>
&self,
where_json: String,
client_index: i32
) -> Result<String>
Method gets a count of entities based on the where clause
fn handle_entity_get_page(
&self,
json_context: String,
client_index: i32
) -> Result<String>
&self,
json_context: String,
client_index: i32
) -> Result<String>
Method uses a paging system to iterate through user entities. After retrieving a page of entities with this method, use GetPageOffset() to retrieve previous or next pages.
fn handle_entity_get_page_offset(
&self,
context: String,
page_offset: i32,
client_index: i32
) -> Result<String>
&self,
context: String,
page_offset: i32,
client_index: i32
) -> Result<String>
Method to retrieve previous or next pages after having called the GetPage method.
fn handle_entity_increment_user_entity_data(
&self,
entity_id: String,
json_data: String,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
json_data: String,
client_index: i32
) -> Result<String>
Partial increment of entity data field items. Partial set of items incremented as specified.
fn handle_entity_increment_shared_user_entity_data(
&self,
entity_id: String,
target_profile_id: String,
json_data: String,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
target_profile_id: String,
json_data: String,
client_index: i32
) -> Result<String>
Partial increment of shared entity data field items. Partial set of items incremented as specified.
fn handle_event_send_event(
&self,
to_profile_id: String,
event_type: String,
json_event_data: String,
client_index: i32
) -> Result<String>
&self,
to_profile_id: String,
event_type: String,
json_event_data: String,
client_index: i32
) -> Result<String>
Sends an event to the designated profile id with the attached json data. Any events that have been sent to a user will show up in their incoming event mailbox. If the recordLocally flag is set to true, a copy of this event (with the exact same event id) will be stored in the sending user's "sent" event mailbox.
fn handle_event_update_incoming_event_data(
&self,
ev_id: String,
json_event_data: String,
client_index: i32
) -> Result<String>
&self,
ev_id: String,
json_event_data: String,
client_index: i32
) -> Result<String>
Updates an event in the user's incoming event mailbox.
fn handle_event_delete_incoming_event(
&self,
ev_id: String,
client_index: i32
) -> Result<String>
&self,
ev_id: String,
client_index: i32
) -> Result<String>
Delete an event out of the user's incoming mailbox.
fn handle_event_get_events(&self, client_index: i32) -> Result<String>
Get the events currently queued for the user.
fn handle_file_upload_file(
&self,
cloud_path: String,
cloud_filename: String,
shareable: bool,
replace_if_exists: bool,
local_path: String,
client_index: i32
) -> Result<String>
&self,
cloud_path: String,
cloud_filename: String,
shareable: bool,
replace_if_exists: bool,
local_path: String,
client_index: i32
) -> Result<String>
Prepares a user file upload. On success the file will begin uploading to the brainCloud server.To be informed of success/failure of the upload register an IFileUploadCallback with the BrainCloudClient class.
fn handle_file_cancel_upload(
&self,
upload_id: String,
client_index: i32
) -> Result<()>
&self,
upload_id: String,
client_index: i32
) -> Result<()>
Method cancels an upload. If an IFileUploadCallback has been registered with the BrainCloudClient class, the fileUploadFailed callback method will be called once the upload has been canceled. NOTE: The upload will still continue in the background on versions of Unity before 5.3 and on Unity mobile platforms.
fn handle_file_get_upload_progress(
&self,
upload_id: String,
client_index: i32
) -> Result<OrderedFloat<f64>>
&self,
upload_id: String,
client_index: i32
) -> Result<OrderedFloat<f64>>
Returns the progress of the given upload from 0.0 to 1.0 or -1 if upload not found. NOTE: This will always return 1 on Unity mobile platforms.
fn handle_file_get_upload_bytes_transferred(
&self,
upload_id: String,
client_index: i32
) -> Result<i64>
&self,
upload_id: String,
client_index: i32
) -> Result<i64>
Returns the number of bytes uploaded or -1 if upload not found. NOTE: This will always return the total bytes to transfer on Unity mobile platforms.
fn handle_file_get_upload_total_bytes_to_transfer(
&self,
upload_id: String,
client_index: i32
) -> Result<i64>
&self,
upload_id: String,
client_index: i32
) -> Result<i64>
Returns the total number of bytes that will be uploaded or -1 if upload not found.
fn handle_file_list_user_files_s_f_o(&self, client_index: i32) -> Result<String>
List all user files
fn handle_file_list_user_files_s_n_s_f_o(
&self,
cloud_path: String,
recurse: bool,
client_index: i32
) -> Result<String>
&self,
cloud_path: String,
recurse: bool,
client_index: i32
) -> Result<String>
List user files from the given cloud path
fn handle_file_delete_user_file(
&self,
cloud_path: String,
cloud_file_name: String,
client_index: i32
) -> Result<String>
&self,
cloud_path: String,
cloud_file_name: String,
client_index: i32
) -> Result<String>
Deletes a single user file.
fn handle_file_delete_user_files(
&self,
cloud_path: String,
recurse: bool,
client_index: i32
) -> Result<String>
&self,
cloud_path: String,
recurse: bool,
client_index: i32
) -> Result<String>
Delete multiple user files
fn handle_file_get_c_d_n_url(
&self,
cloud_path: String,
cloud_filename: String,
client_index: i32
) -> Result<String>
&self,
cloud_path: String,
cloud_filename: String,
client_index: i32
) -> Result<String>
Returns the CDN URL for a file object.
fn handle_friend_find_user_by_universal_id(
&self,
search_text: String,
max_results: i32,
client_index: i32
) -> Result<String>
&self,
search_text: String,
max_results: i32,
client_index: i32
) -> Result<String>
fn handle_friend_read_friend_entity(
&self,
entity_id: String,
friend_id: String,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
friend_id: String,
client_index: i32
) -> Result<String>
Returns a particular entity of a particular friend.
fn handle_friend_read_friends_entities(
&self,
entity_type: String,
client_index: i32
) -> Result<String>
&self,
entity_type: String,
client_index: i32
) -> Result<String>
Returns entities of all friends based on type and/or subtype.
fn handle_friend_read_friend_user_state(
&self,
friend_id: String,
client_index: i32
) -> Result<String>
&self,
friend_id: String,
client_index: i32
) -> Result<String>
Returns user state of a particular friend.
fn handle_friend_get_summary_data_for_profile_id(
&self,
player_id: String,
client_index: i32
) -> Result<String>
&self,
player_id: String,
client_index: i32
) -> Result<String>
Returns user state of a particular user.
fn handle_friend_get_summary_data_for_profile_ids(
&self,
player_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
player_ids: Vec<String>,
client_index: i32
) -> Result<String>
Returns user state of a set of users.
fn handle_friend_get_summary_data_for_friends(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Returns user state of the player's friends.
fn handle_friend_get_summary_data_for_recently_met_players(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Returns user state of player's recently met.
fn handle_friend_find_users_by_exact_name(
&self,
search_text: String,
max_results: i32,
client_index: i32
) -> Result<String>
&self,
search_text: String,
max_results: i32,
client_index: i32
) -> Result<String>
Finds a list of users matching the search text by performing an exact search of all user names.
fn handle_friend_find_users_by_substr_name(
&self,
search_text: String,
max_results: i32,
client_index: i32
) -> Result<String>
&self,
search_text: String,
max_results: i32,
client_index: i32
) -> Result<String>
Finds a list of users matching the search text by performing a substring search of all user names.
fn handle_friend_list_friends(
&self,
friend_platform: FriendPlatform,
include_summary_data: bool,
client_index: i32
) -> Result<String>
&self,
friend_platform: FriendPlatform,
include_summary_data: bool,
client_index: i32
) -> Result<String>
Retrieves a list of user and friend platform information for all friends of the current user.
fn handle_friend_add_friends(
&self,
profile_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
profile_ids: Vec<String>,
client_index: i32
) -> Result<String>
Links the current user and the specified users as brainCloud friends.
fn handle_friend_remove_friends(
&self,
profile_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
profile_ids: Vec<String>,
client_index: i32
) -> Result<String>
Unlinks the current user and the specified users as brainCloud friends.
fn handle_friend_get_users_online_status(
&self,
profile_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
profile_ids: Vec<String>,
client_index: i32
) -> Result<String>
Get users online status
fn handle_friend_send_friend_invitation(
&self,
to_player_id: String,
client_index: i32
) -> Result<String>
&self,
to_player_id: String,
client_index: i32
) -> Result<String>
fn handle_friend_list_friend_invitations_received(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
fn handle_friend_list_friend_invitations_sent(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
fn handle_friend_accept_friend_invitation(
&self,
from_player_id: String,
client_index: i32
) -> Result<String>
&self,
from_player_id: String,
client_index: i32
) -> Result<String>
fn handle_friend_reject_friend_invitation(
&self,
from_player_id: String,
client_index: i32
) -> Result<String>
&self,
from_player_id: String,
client_index: i32
) -> Result<String>
fn handle_friend_remove_friend(
&self,
player_id: String,
client_index: i32
) -> Result<String>
&self,
player_id: String,
client_index: i32
) -> Result<String>
fn handle_gamification_read_all_gamification(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method retrieves all gamification data for the player.
fn handle_gamification_read_milestones(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method retrieves all milestones defined for the game.
fn handle_gamification_read_achievements(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Read all of the achievements defined for the game.
fn handle_gamification_read_xp_levels_meta_data(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Method returns all defined xp levels and any rewards associated with those xp levels.
fn handle_gamification_read_achieved_achievements(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method retrives the list of achieved achievements.
fn handle_gamification_read_completed_milestones(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method retrieves the list of completed milestones.
fn handle_gamification_read_in_progress_milestones(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method retrieves the list of in progress milestones
fn handle_gamification_read_milestones_by_category(
&self,
category: String,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
category: String,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method retrieves milestones of the given category.
fn handle_gamification_award_achievements(
&self,
achievement_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
achievement_ids: Vec<String>,
client_index: i32
) -> Result<String>
Method will award the achievements specified. On success, this will call AwardThirdPartyAchievement to hook into the client-side Achievement service (ie GameCentre, Facebook etc).
fn handle_gamification_read_quests(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method retrieves all of the quests defined for the game.
fn handle_gamification_read_completed_quests(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method returns all completed quests.
fn handle_gamification_read_in_progress_quests(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method returns all in progress quests.
fn handle_gamification_read_not_started_quests(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method returns all quests that haven't been started.
fn handle_gamification_read_quests_with_status(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method returns all quests with status.
fn handle_gamification_read_quests_with_basic_percentage(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method returns all quests with a basic percentage.
fn handle_gamification_read_quests_with_complex_percentage(
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method returns all quests with a complex percentage.
fn handle_gamification_read_quests_by_category(
&self,
category: String,
include_meta_data: bool,
client_index: i32
) -> Result<String>
&self,
category: String,
include_meta_data: bool,
client_index: i32
) -> Result<String>
Method returns all quests for the given category.
fn handle_gamification_reset_milestones(
&self,
milestone_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
milestone_ids: Vec<String>,
client_index: i32
) -> Result<String>
Sets the specified milestones' statuses to LOCKED.
fn handle_global_app_read_properties(&self, client_index: i32) -> Result<String>
Method reads all the global properties of the game
fn handle_global_entity_create_entity(
&self,
entity_type: String,
time_to_live: i64,
json_entity_acl: String,
json_entity_data: String,
client_index: i32
) -> Result<String>
&self,
entity_type: String,
time_to_live: i64,
json_entity_acl: String,
json_entity_data: String,
client_index: i32
) -> Result<String>
Method creates a new entity on the server.
fn handle_global_entity_create_entity_with_indexed_id(
&self,
entity_type: String,
indexed_id: String,
time_to_live: i64,
json_entity_acl: String,
json_entity_data: String,
client_index: i32
) -> Result<String>
&self,
entity_type: String,
indexed_id: String,
time_to_live: i64,
json_entity_acl: String,
json_entity_data: String,
client_index: i32
) -> Result<String>
Method creates a new entity on the server with an indexed id.
fn handle_global_entity_update_entity(
&self,
entity_id: String,
version: i32,
json_entity_data: String,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
version: i32,
json_entity_data: String,
client_index: i32
) -> Result<String>
Method updates an existing entity on the server.
fn handle_global_entity_update_entity_acl(
&self,
entity_id: String,
version: i32,
json_entity_acl: String,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
version: i32,
json_entity_acl: String,
client_index: i32
) -> Result<String>
Method updates an existing entity's Acl on the server.
fn handle_global_entity_update_entity_time_to_live(
&self,
entity_id: String,
version: i32,
time_to_live: i64,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
version: i32,
time_to_live: i64,
client_index: i32
) -> Result<String>
Method updates an existing entity's time to live on the server.
fn handle_global_entity_delete_entity(
&self,
entity_id: String,
version: i32,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
version: i32,
client_index: i32
) -> Result<String>
Method deletes an existing entity on the server.
fn handle_global_entity_read_entity(
&self,
entity_id: String,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
client_index: i32
) -> Result<String>
Method reads an existing entity from the server.
fn handle_global_entity_get_list(
&self,
where_json: String,
order_by_json: String,
max_return: i32,
client_index: i32
) -> Result<String>
&self,
where_json: String,
order_by_json: String,
max_return: i32,
client_index: i32
) -> Result<String>
Method gets list of entities from the server base on type and/or where clause
fn handle_global_entity_get_list_by_indexed_id(
&self,
entity_indexed_id: String,
max_return: i32,
client_index: i32
) -> Result<String>
&self,
entity_indexed_id: String,
max_return: i32,
client_index: i32
) -> Result<String>
Method gets list of entities from the server base on indexed id
fn handle_global_entity_get_list_count(
&self,
where_json: String,
client_index: i32
) -> Result<String>
&self,
where_json: String,
client_index: i32
) -> Result<String>
Method gets a count of entities based on the where clause
fn handle_global_entity_get_page(
&self,
json_context: String,
client_index: i32
) -> Result<String>
&self,
json_context: String,
client_index: i32
) -> Result<String>
Method uses a paging system to iterate through Global Entities. After retrieving a page of Global Entities with this method, use GetPageOffset() to retrieve previous or next pages.
fn handle_global_entity_get_page_offset(
&self,
context: String,
page_offset: i32,
client_index: i32
) -> Result<String>
&self,
context: String,
page_offset: i32,
client_index: i32
) -> Result<String>
Method to retrieve previous or next pages after having called the GetPage method.
fn handle_global_entity_increment_global_entity_data(
&self,
entity_id: String,
json_data: String,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
json_data: String,
client_index: i32
) -> Result<String>
Partial increment of global entity data field items. Partial set of items incremented as specified.
fn handle_global_entity_get_random_entities_matching(
&self,
where_json: String,
max_return: i32,
client_index: i32
) -> Result<String>
&self,
where_json: String,
max_return: i32,
client_index: i32
) -> Result<String>
Gets a list of up to randomCount randomly selected entities from the server based on the where condition and specified maximum return count.
fn handle_global_entity_update_entity_owner_and_acl(
&self,
entity_id: String,
version: i64,
owner_id: String,
acl: JSON,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
version: i64,
owner_id: String,
acl: JSON,
client_index: i32
) -> Result<String>
Method updates an existing entity's Owner and Acl on the server.
fn handle_global_entity_make_system_entity(
&self,
entity_id: String,
version: i64,
acl: JSON,
client_index: i32
) -> Result<String>
&self,
entity_id: String,
version: i64,
acl: JSON,
client_index: i32
) -> Result<String>
Method clears the owner id of an existing entity and sets the Acl on the server.
fn handle_global_statistics_read_all_global_stats(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Method returns all of the global statistics.
fn handle_global_statistics_read_global_stats_subset(
&self,
global_stats: Vec<String>,
client_index: i32
) -> Result<String>
&self,
global_stats: Vec<String>,
client_index: i32
) -> Result<String>
Reads a subset of global statistics as defined by the input JSON.
fn handle_global_statistics_read_global_stats_for_category(
&self,
category: String,
client_index: i32
) -> Result<String>
&self,
category: String,
client_index: i32
) -> Result<String>
Method retrieves the global statistics for the given category.
fn handle_global_statistics_increment_global_stats(
&self,
json_data: String,
client_index: i32
) -> Result<String>
&self,
json_data: String,
client_index: i32
) -> Result<String>
Atomically increment (or decrement) global statistics. Global statistics are defined through the brainCloud portal.
fn handle_global_statistics_process_statistics(
&self,
statistics_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
&self,
statistics_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
Apply statistics grammar to a partial set of statistics.
fn handle_group_accept_group_invitation(
&self,
group_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
client_index: i32
) -> Result<String>
Accept an outstanding invitation to join the group.
fn handle_group_add_group_member(
&self,
group_id: String,
profile_id: String,
role: Role,
json_attributes: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
profile_id: String,
role: Role,
json_attributes: String,
client_index: i32
) -> Result<String>
Add a member to the group.
fn handle_group_approve_group_join_request(
&self,
group_id: String,
profile_id: String,
role: Role,
json_attributes: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
profile_id: String,
role: Role,
json_attributes: String,
client_index: i32
) -> Result<String>
Approve an outstanding request to join the group.
fn handle_group_auto_join_group(
&self,
group_type: String,
auto_join_strategy: AutoJoinStrategy,
data_query_json: String,
client_index: i32
) -> Result<String>
&self,
group_type: String,
auto_join_strategy: AutoJoinStrategy,
data_query_json: String,
client_index: i32
) -> Result<String>
Automatically join an open group that matches the search criteria and has space available.
fn handle_group_cancel_group_invitation(
&self,
group_id: String,
profile_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
profile_id: String,
client_index: i32
) -> Result<String>
Cancel an outstanding invitation to the group.
fn handle_group_create_group(
&self,
name: String,
group_type: String,
is_open_group: bool,
acl: JSON,
json_data: String,
json_owner_attributes: String,
json_default_member_attributes: String,
client_index: i32
) -> Result<String>
&self,
name: String,
group_type: String,
is_open_group: bool,
acl: JSON,
json_data: String,
json_owner_attributes: String,
json_default_member_attributes: String,
client_index: i32
) -> Result<String>
Create a group.
fn handle_group_create_group_entity(
&self,
group_id: String,
entity_type: String,
is_owned_by_group_member: bool,
acl: JSON,
json_data: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
entity_type: String,
is_owned_by_group_member: bool,
acl: JSON,
json_data: String,
client_index: i32
) -> Result<String>
Create a group entity.
fn handle_group_delete_group(
&self,
group_id: String,
version: i64,
client_index: i32
) -> Result<String>
&self,
group_id: String,
version: i64,
client_index: i32
) -> Result<String>
Delete a group.
fn handle_group_delete_group_entity(
&self,
group_id: String,
entity_id: String,
version: i64,
client_index: i32
) -> Result<String>
&self,
group_id: String,
entity_id: String,
version: i64,
client_index: i32
) -> Result<String>
Delete a group entity.
fn handle_group_get_my_groups(&self, client_index: i32) -> Result<String>
Read information on groups to which the current user belongs.
fn handle_group_increment_group_data(
&self,
group_id: String,
json_data: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
json_data: String,
client_index: i32
) -> Result<String>
Increment elements for the group's data field.
fn handle_group_increment_group_entity_data(
&self,
group_id: String,
entity_id: String,
json_data: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
entity_id: String,
json_data: String,
client_index: i32
) -> Result<String>
Increment elements for the group entity's data field.
fn handle_group_invite_group_member(
&self,
group_id: String,
profile_id: String,
role: Role,
json_attributes: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
profile_id: String,
role: Role,
json_attributes: String,
client_index: i32
) -> Result<String>
Invite a member to the group.
fn handle_group_join_group(
&self,
group_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
client_index: i32
) -> Result<String>
Join an open group or request to join a closed group.
fn handle_group_leave_group(
&self,
group_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
client_index: i32
) -> Result<String>
Leave a group in which the user is a member.
fn handle_group_list_groups_page(
&self,
json_context: String,
client_index: i32
) -> Result<String>
&self,
json_context: String,
client_index: i32
) -> Result<String>
Retrieve a page of group summary information based on the specified context.
fn handle_group_list_groups_page_by_offset(
&self,
context: String,
page_offset: i32,
client_index: i32
) -> Result<String>
&self,
context: String,
page_offset: i32,
client_index: i32
) -> Result<String>
Retrieve a page of group summary information based on the encoded context and specified page offset.
fn handle_group_list_groups_with_member(
&self,
profile_id: String,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
client_index: i32
) -> Result<String>
Read information on groups to which the specified user belongs. Access is subject to restrictions.
fn handle_group_read_group(
&self,
group_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
client_index: i32
) -> Result<String>
Read the specified group.
fn handle_group_read_group_data(
&self,
group_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
client_index: i32
) -> Result<String>
Read the data of the specified group.
fn handle_group_read_group_entities_page(
&self,
json_context: String,
client_index: i32
) -> Result<String>
&self,
json_context: String,
client_index: i32
) -> Result<String>
Read a page of group entity information.
fn handle_group_read_group_entities_page_by_offset(
&self,
encoded_context: String,
page_offset: i32,
client_index: i32
) -> Result<String>
&self,
encoded_context: String,
page_offset: i32,
client_index: i32
) -> Result<String>
Read a page of group entity information.
fn handle_group_read_group_entity(
&self,
group_id: String,
entity_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
entity_id: String,
client_index: i32
) -> Result<String>
Read the specified group entity.
fn handle_group_read_group_members(
&self,
group_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
client_index: i32
) -> Result<String>
Read the members of the group.
fn handle_group_reject_group_invitation(
&self,
group_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
client_index: i32
) -> Result<String>
Reject an outstanding invitation to join the group.
fn handle_group_reject_group_join_request(
&self,
group_id: String,
profile_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
profile_id: String,
client_index: i32
) -> Result<String>
Reject an outstanding request to join the group.
fn handle_group_remove_group_member(
&self,
group_id: String,
profile_id: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
profile_id: String,
client_index: i32
) -> Result<String>
Remove a member from the group.
fn handle_group_update_group_data(
&self,
group_id: String,
version: i64,
json_data: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
version: i64,
json_data: String,
client_index: i32
) -> Result<String>
Updates a group's data.
fn handle_group_update_group_entity_data(
&self,
group_id: String,
entity_id: String,
version: i64,
json_data: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
entity_id: String,
version: i64,
json_data: String,
client_index: i32
) -> Result<String>
Update a group entity.
fn handle_group_update_group_member(
&self,
group_id: String,
profile_id: String,
role: Role,
json_attributes: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
profile_id: String,
role: Role,
json_attributes: String,
client_index: i32
) -> Result<String>
Update a member of the group.
fn handle_group_update_group_name(
&self,
group_id: String,
name: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
name: String,
client_index: i32
) -> Result<String>
Updates a group's name.
fn handle_identity_attach_email_identity(
&self,
email: String,
password: String,
client_index: i32
) -> Result<String>
&self,
email: String,
password: String,
client_index: i32
) -> Result<String>
Attach a Email and Password identity to the current profile.
fn handle_identity_merge_email_identity(
&self,
email: String,
password: String,
client_index: i32
) -> Result<String>
&self,
email: String,
password: String,
client_index: i32
) -> Result<String>
Merge the profile associated with the provided e=mail with the current profile.
fn handle_identity_detach_email_identity(
&self,
email: String,
continue_anon: bool,
client_index: i32
) -> Result<String>
&self,
email: String,
continue_anon: bool,
client_index: i32
) -> Result<String>
Detach the e-mail identity from the current profile
fn handle_identity_attach_universal_identity(
&self,
user_id: String,
password: String,
client_index: i32
) -> Result<String>
&self,
user_id: String,
password: String,
client_index: i32
) -> Result<String>
Attach a Universal (userId + password) identity to the current profile.
fn handle_identity_merge_universal_identity(
&self,
user_id: String,
password: String,
client_index: i32
) -> Result<String>
&self,
user_id: String,
password: String,
client_index: i32
) -> Result<String>
Merge the profile associated with the provided e=mail with the current profile.
fn handle_identity_detach_universal_identity(
&self,
user_id: String,
continue_anon: bool,
client_index: i32
) -> Result<String>
&self,
user_id: String,
continue_anon: bool,
client_index: i32
) -> Result<String>
Detach the universal identity from the current profile
fn handle_identity_switch_to_child_profile(
&self,
child_profile_id: String,
child_app_id: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
child_profile_id: String,
child_app_id: String,
force_create: bool,
client_index: i32
) -> Result<String>
Switch to a Child Profile
fn handle_identity_switch_to_singleton_child_profile(
&self,
child_app_id: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
child_app_id: String,
force_create: bool,
client_index: i32
) -> Result<String>
Switches to the child profile of an app when only one profile exists If multiple profiles exist this returns an error
fn handle_identity_attach_parent_with_identity(
&self,
external_id: String,
authentication_token: String,
authentication_type: String,
external_auth_name: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
external_id: String,
authentication_token: String,
authentication_type: String,
external_auth_name: String,
force_create: bool,
client_index: i32
) -> Result<String>
Attach a new identity to a parent app
fn handle_identity_switch_to_parent_profile(
&self,
parent_level_name: String,
client_index: i32
) -> Result<String>
&self,
parent_level_name: String,
client_index: i32
) -> Result<String>
Switch to a Parent Profile
fn handle_identity_detach_parent(&self, client_index: i32) -> Result<String>
Detaches parent from this user's profile
fn handle_identity_get_child_profiles(
&self,
include_summary_data: bool,
client_index: i32
) -> Result<String>
&self,
include_summary_data: bool,
client_index: i32
) -> Result<String>
Returns a list of all child profiles in child Apps
fn handle_identity_get_identities(&self, client_index: i32) -> Result<String>
Retrieve list of identities
fn handle_identity_get_expired_identities(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Retrieve list of expired identities
fn handle_identity_refresh_identity(
&self,
external_id: String,
authentication_token: String,
authentication_type: String,
client_index: i32
) -> Result<String>
&self,
external_id: String,
authentication_token: String,
authentication_type: String,
client_index: i32
) -> Result<String>
Refreshes an identity for this user
fn handle_identity_change_email_identity(
&self,
old_email_address: String,
password: String,
new_email_address: String,
update_contact_email: bool,
client_index: i32
) -> Result<String>
&self,
old_email_address: String,
password: String,
new_email_address: String,
update_contact_email: bool,
client_index: i32
) -> Result<String>
Allows email identity email address to be changed
fn handle_identity_attach_peer_profile(
&self,
peer: String,
external_id: String,
authentication_token: String,
authentication_type: String,
external_auth_name: String,
force_create: bool,
client_index: i32
) -> Result<String>
&self,
peer: String,
external_id: String,
authentication_token: String,
authentication_type: String,
external_auth_name: String,
force_create: bool,
client_index: i32
) -> Result<String>
Attaches a peer identity to this user's profile
fn handle_identity_detach_peer(
&self,
peer: String,
client_index: i32
) -> Result<String>
&self,
peer: String,
client_index: i32
) -> Result<String>
Detaches a peer identity from this user's profile
fn handle_identity_get_peer_profiles(&self, client_index: i32) -> Result<String>
Retrieves a list of attached peer profiles
fn handle_mail_send_basic_email(
&self,
profile_id: String,
subject: String,
body: String,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
subject: String,
body: String,
client_index: i32
) -> Result<String>
Sends a simple text email to the specified user
fn handle_mail_send_advanced_email(
&self,
profile_id: String,
json_service_params: String,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
json_service_params: String,
client_index: i32
) -> Result<String>
Sends an advanced email to the specified user
fn handle_mail_send_advanced_email_by_address(
&self,
email_address: String,
json_service_params: String,
client_index: i32
) -> Result<String>
&self,
email_address: String,
json_service_params: String,
client_index: i32
) -> Result<String>
Sends an advanced email to the specified email address
fn handle_match_making_read(&self, client_index: i32) -> Result<String>
Read match making record
fn handle_match_making_set_player_rating(
&self,
player_rating: i64,
client_index: i32
) -> Result<String>
&self,
player_rating: i64,
client_index: i32
) -> Result<String>
Sets player rating
fn handle_match_making_reset_player_rating(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Resets player rating
fn handle_match_making_increment_player_rating(
&self,
increment: i64,
client_index: i32
) -> Result<String>
&self,
increment: i64,
client_index: i32
) -> Result<String>
Increments player rating
fn handle_match_making_decrement_player_rating(
&self,
decrement: i64,
client_index: i32
) -> Result<String>
&self,
decrement: i64,
client_index: i32
) -> Result<String>
Decrements player rating
fn handle_match_making_turn_shield_on(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Turns shield on
fn handle_match_making_turn_shield_on_for(
&self,
minutes: i32,
client_index: i32
) -> Result<String>
&self,
minutes: i32,
client_index: i32
) -> Result<String>
Turns shield on for the specified number of minutes
fn handle_match_making_turn_shield_off(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Turns shield off
fn handle_match_making_increment_shield_on_for(
&self,
minutes: i32,
client_index: i32
) -> Result<String>
&self,
minutes: i32,
client_index: i32
) -> Result<String>
Increases the shield on time by specified number of minutes
fn handle_match_making_get_shield_expiry(
&self,
player_id: String,
client_index: i32
) -> Result<String>
&self,
player_id: String,
client_index: i32
) -> Result<String>
Gets the shield expiry for the given player id. Passing in a null player id will return the shield expiry for the current player. The value returned is the time in UTC millis when the shield will expire.
fn handle_match_making_find_players(
&self,
range_delta: i64,
num_matches: i64,
client_index: i32
) -> Result<String>
&self,
range_delta: i64,
num_matches: i64,
client_index: i32
) -> Result<String>
Finds matchmaking enabled players
fn handle_match_making_find_players_with_attributes(
&self,
range_delta: i64,
num_matches: i64,
json_attributes: String,
client_index: i32
) -> Result<String>
&self,
range_delta: i64,
num_matches: i64,
json_attributes: String,
client_index: i32
) -> Result<String>
Finds matchmaking enabled players with additional attributes
fn handle_match_making_find_players_using_filter(
&self,
range_delta: i64,
num_matches: i64,
json_extra_parms: String,
client_index: i32
) -> Result<String>
&self,
range_delta: i64,
num_matches: i64,
json_extra_parms: String,
client_index: i32
) -> Result<String>
Finds matchmaking enabled players using a cloud code filter
fn handle_match_making_find_players_with_attributes_using_filter(
&self,
range_delta: i64,
num_matches: i64,
json_attributes: String,
json_extra_parms: String,
client_index: i32
) -> Result<String>
&self,
range_delta: i64,
num_matches: i64,
json_attributes: String,
json_extra_parms: String,
client_index: i32
) -> Result<String>
Finds matchmaking enabled players using a cloud code filter and additional attributes
fn handle_match_making_enable_match_making(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Enables Match Making for the Player
fn handle_match_making_disable_match_making(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Disables Match Making for the Player
fn handle_one_way_match_start_match(
&self,
other_player_id: String,
range_delta: i64,
client_index: i32
) -> Result<String>
&self,
other_player_id: String,
range_delta: i64,
client_index: i32
) -> Result<String>
Starts a match
fn handle_one_way_match_cancel_match(
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
Cancels a match
fn handle_one_way_match_complete_match(
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
Completes a match
fn handle_playback_stream_start_stream(
&self,
target_player_id: String,
include_shared_data: bool,
client_index: i32
) -> Result<String>
&self,
target_player_id: String,
include_shared_data: bool,
client_index: i32
) -> Result<String>
Starts a stream
fn handle_playback_stream_read_stream(
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
Reads a stream
fn handle_playback_stream_end_stream(
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
Ends a stream
fn handle_playback_stream_delete_stream(
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
&self,
playback_stream_id: String,
client_index: i32
) -> Result<String>
Deletes a stream
fn handle_playback_stream_add_event(
&self,
playback_stream_id: String,
event_data: String,
summary: String,
client_index: i32
) -> Result<String>
&self,
playback_stream_id: String,
event_data: String,
summary: String,
client_index: i32
) -> Result<String>
Adds a stream event
fn handle_playback_stream_get_recent_streams_for_initiating_player(
&self,
initiating_player_id: String,
max_num_streams: i32,
client_index: i32
) -> Result<String>
&self,
initiating_player_id: String,
max_num_streams: i32,
client_index: i32
) -> Result<String>
Gets recent streams for initiating player
fn handle_playback_stream_get_recent_streams_for_target_player(
&self,
target_player_id: String,
max_num_streams: i32,
client_index: i32
) -> Result<String>
&self,
target_player_id: String,
max_num_streams: i32,
client_index: i32
) -> Result<String>
Gets recent streams for target player
fn handle_player_state_read_user_state(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Read the state of the currently logged in user. This method returns a JSON object describing most of the player's data: entities, statistics, level, currency. Apps will typically call this method after authenticating to get an up-to-date view of the user's data.
fn handle_player_state_delete_user(&self, client_index: i32) -> Result<String>
Completely deletes the user record and all data fully owned by the user. After calling this method, the user will need to re-authenticate and create a new profile. This is mostly used for debugging/qa.
fn handle_player_state_reset_user(&self, client_index: i32) -> Result<String>
This method will delete most data for the currently logged in user. Data which is not deleted includes: currency, credentials, and purchase transactions. ResetUser is different from DeleteUser in that the player record will continue to exist after the reset (so the user does not need to re-authenticate).
fn handle_player_state_logout(&self, client_index: i32) -> Result<String>
Logs user out of server.
fn handle_player_state_update_user_name(
&self,
user_name: String,
client_index: i32
) -> Result<String>
&self,
user_name: String,
client_index: i32
) -> Result<String>
Sets the user name.
fn handle_player_state_update_summary_friend_data(
&self,
json_summary_data: String,
client_index: i32
) -> Result<String>
&self,
json_summary_data: String,
client_index: i32
) -> Result<String>
Updates the "friend summary data" associated with the logged in user. Some operations will return this summary data. For instance the social leaderboards will return the player's score in the leaderboard along with the friend summary data. Generally this data is used to provide a quick overview of the player without requiring a separate API call to read their public stats or entity data.
fn handle_player_state_get_attributes(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Retrieve the user's attributes.
fn handle_player_state_update_attributes(
&self,
json_attributes: String,
wipe_existing: bool,
client_index: i32
) -> Result<String>
&self,
json_attributes: String,
wipe_existing: bool,
client_index: i32
) -> Result<String>
Update user's attributes.
fn handle_player_state_remove_attributes(
&self,
attribute_names: Vec<String>,
client_index: i32
) -> Result<String>
&self,
attribute_names: Vec<String>,
client_index: i32
) -> Result<String>
Remove user's attributes.
fn handle_player_state_update_user_picture_url(
&self,
picture_url: String,
client_index: i32
) -> Result<String>
&self,
picture_url: String,
client_index: i32
) -> Result<String>
Updates player's picture URL.
fn handle_player_state_update_contact_email(
&self,
contact_email: String,
client_index: i32
) -> Result<String>
&self,
contact_email: String,
client_index: i32
) -> Result<String>
Update the user's contact email. Note this is unrelated to email authentication.
fn handle_player_statistics_read_all_user_stats(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Read all available user statistics.
fn handle_player_statistics_read_user_stats_subset(
&self,
player_stats: Vec<String>,
client_index: i32
) -> Result<String>
&self,
player_stats: Vec<String>,
client_index: i32
) -> Result<String>
Reads a subset of user statistics as defined by the input JSON.
fn handle_player_statistics_read_user_stats_for_category(
&self,
category: String,
client_index: i32
) -> Result<String>
&self,
category: String,
client_index: i32
) -> Result<String>
Method retrieves the user statistics for the given category.
fn handle_player_statistics_reset_all_user_stats(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Reset all of the statistics for this user back to their initial value.
fn handle_player_statistics_increment_user_stats_s_s_f_o(
&self,
json_data: String,
client_index: i32
) -> Result<String>
&self,
json_data: String,
client_index: i32
) -> Result<String>
Atomically increment (or decrement) user statistics. Any rewards that are triggered from user statistic increments will be considered. User statistics are defined through the brainCloud portal. Note also that the "xpCapped" property is returned (true/false depending on whether the xp cap is turned on and whether the user has hit it).
fn handle_player_statistics_increment_user_stats_d_s_f_o(
&self,
dict_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
&self,
dict_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
Atomically increment (or decrement) user statistics. Any rewards that are triggered from user statistic increments will be considered. User statistics are defined through the brainCloud portal. Note also that the "xpCapped" property is returned (true/false depending on whether the xp cap is turned on and whether the user has hit it).
fn handle_player_statistics_process_statistics(
&self,
statistics_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
&self,
statistics_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
Apply statistics grammar to a partial set of statistics.
fn handle_player_statistics_get_next_experience_level(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Returns JSON representing the next experience level for the user.
fn handle_player_statistics_increment_experience_points(
&self,
xp_value: i32,
client_index: i32
) -> Result<String>
&self,
xp_value: i32,
client_index: i32
) -> Result<String>
Increments the user's experience. If the user goes up a level, the new level details will be returned along with a list of rewards.
fn handle_player_statistics_set_experience_points(
&self,
xp_value: i32,
client_index: i32
) -> Result<String>
&self,
xp_value: i32,
client_index: i32
) -> Result<String>
Sets the user's experience to an absolute value. Note that this is simply a set and will not reward the user if their level changes as a result.
fn handle_player_statistics_event_trigger_stats_event(
&self,
event_name: String,
event_multiplier: i32,
client_index: i32
) -> Result<String>
&self,
event_name: String,
event_multiplier: i32,
client_index: i32
) -> Result<String>
Trigger an event server side that will increase the user statistics. This may cause one or more awards to be sent back to the user - could be achievements, experience, etc. Achievements will be sent by this client library to the appropriate awards service (Apple Game Center, etc).
This mechanism supercedes the PlayerStatisticsService API methods, since PlayerStatisticsService API method only update the raw statistics without triggering the rewards.
fn handle_player_statistics_event_trigger_stats_events(
&self,
json_data: String,
client_index: i32
) -> Result<String>
&self,
json_data: String,
client_index: i32
) -> Result<String>
See documentation for TriggerStatsEvent for more documentation.
fn handle_product_get_currency(
&self,
currency_type: String,
client_index: i32
) -> Result<String>
&self,
currency_type: String,
client_index: i32
) -> Result<String>
Gets the player's currency for the given currency type or all currency types if null passed in.
fn handle_product_get_sales_inventory(
&self,
platform: String,
user_currency: String,
client_index: i32
) -> Result<String>
&self,
platform: String,
user_currency: String,
client_index: i32
) -> Result<String>
Method gets the active sales inventory for the passed-in currency type.
fn handle_product_get_sales_inventory_by_category(
&self,
platform: String,
user_currency: String,
category: String,
client_index: i32
) -> Result<String>
&self,
platform: String,
user_currency: String,
category: String,
client_index: i32
) -> Result<String>
Method gets the active sales inventory for the passed-in currency type and category.
fn handle_product_verify_microsoft_receipt(
&self,
receipt: String,
client_index: i32
) -> Result<String>
&self,
receipt: String,
client_index: i32
) -> Result<String>
Verify Microsoft Receipt. On success, the player will be awarded the associated currencies.
fn handle_product_get_eligible_promotions(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Returns the eligible promotions for the player.
fn handle_product_verify_itunes_receipt(
&self,
base64_enc_receipt_data: String,
client_index: i32
) -> Result<String>
&self,
base64_enc_receipt_data: String,
client_index: i32
) -> Result<String>
Verify ITunes Receipt. On success, the player will be awarded the associated currencies.
fn handle_profanity_profanity_check(
&self,
text: String,
languages: String,
flag_email: bool,
flag_phone: bool,
flag_urls: bool,
client_index: i32
) -> Result<String>
&self,
text: String,
languages: String,
flag_email: bool,
flag_phone: bool,
flag_urls: bool,
client_index: i32
) -> Result<String>
Checks supplied text for profanity.
fn handle_profanity_profanity_replace_text(
&self,
text: String,
replace_symbol: String,
languages: String,
flag_email: bool,
flag_phone: bool,
flag_urls: bool,
client_index: i32
) -> Result<String>
&self,
text: String,
replace_symbol: String,
languages: String,
flag_email: bool,
flag_phone: bool,
flag_urls: bool,
client_index: i32
) -> Result<String>
Replaces the characters of profanity text with a passed character(s).
fn handle_profanity_profanity_identify_bad_words(
&self,
text: String,
languages: String,
flag_email: bool,
flag_phone: bool,
flag_urls: bool,
client_index: i32
) -> Result<String>
&self,
text: String,
languages: String,
flag_email: bool,
flag_phone: bool,
flag_urls: bool,
client_index: i32
) -> Result<String>
Checks supplied text for profanity and returns a list of bad wors.
fn handle_push_notification_deregister_all_push_notification_device_tokens(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Deregisters all device tokens currently registered to the user.
fn handle_push_notification_deregister_push_notification_device_token(
&self,
platform: String,
token: String,
client_index: i32
) -> Result<String>
&self,
platform: String,
token: String,
client_index: i32
) -> Result<String>
Deregisters the given device token from the server to disable this device from receiving push notifications.
fn handle_push_notification_register_push_notification_device_token(
&self,
platform: String,
token: String,
client_index: i32
) -> Result<String>
&self,
platform: String,
token: String,
client_index: i32
) -> Result<String>
Registers the given device token with the server to enable this device to receive push notifications.
fn handle_push_notification_send_simple_push_notification(
&self,
to_profile_id: String,
message: String,
client_index: i32
) -> Result<String>
&self,
to_profile_id: String,
message: String,
client_index: i32
) -> Result<String>
Sends a simple push notification based on the passed in message. NOTE: It is possible to send a push notification to oneself.
fn handle_push_notification_send_rich_push_notification(
&self,
to_profile_id: String,
notification_template_id: i32,
client_index: i32
) -> Result<String>
&self,
to_profile_id: String,
notification_template_id: i32,
client_index: i32
) -> Result<String>
Sends a notification to a user based on a brainCloud portal configured notification template. NOTE: It is possible to send a push notification to oneself.
fn handle_push_notification_send_rich_push_notification_with_params(
&self,
to_profile_id: String,
notification_template_id: i32,
substitution_json: String,
client_index: i32
) -> Result<String>
&self,
to_profile_id: String,
notification_template_id: i32,
substitution_json: String,
client_index: i32
) -> Result<String>
Sends a notification to a user based on a brainCloud portal configured notification template. Includes JSON defining the substitution params to use with the template. See the Portal documentation for more info. NOTE: It is possible to send a push notification to oneself.
fn handle_push_notification_send_templated_push_notification_to_group(
&self,
group_id: String,
notification_template_id: i32,
substitutions_json: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
notification_template_id: i32,
substitutions_json: String,
client_index: i32
) -> Result<String>
Sends a notification to a "group" of user based on a brainCloud portal configured notification template. Includes JSON defining the substitution params to use with the template. See the Portal documentation for more info.
fn handle_push_notification_send_normalized_push_notification_to_group(
&self,
group_id: String,
alert_content_json: String,
custom_data_json: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
alert_content_json: String,
custom_data_json: String,
client_index: i32
) -> Result<String>
Sends a notification to a "group" of user based on a brainCloud portal configured notification template. Includes JSON defining the substitution params to use with the template. See the Portal documentation for more info.
fn handle_push_notification_schedule_raw_push_notification_u_t_c(
&self,
profile_id: String,
fcm_content: String,
ios_content: String,
facebook_content: String,
start_time: i32,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
fcm_content: String,
ios_content: String,
facebook_content: String,
start_time: i32,
client_index: i32
) -> Result<String>
Schedules raw notifications based on user local time.
fn handle_push_notification_schedule_raw_push_notification_minutes(
&self,
profile_id: String,
fcm_content: String,
ios_content: String,
facebook_content: String,
minutes_from_now: i32,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
fcm_content: String,
ios_content: String,
facebook_content: String,
minutes_from_now: i32,
client_index: i32
) -> Result<String>
Schedules raw notifications based on user local time.
fn handle_push_notification_send_raw_push_notification(
&self,
to_profile_id: String,
fcm_content: String,
ios_content: String,
facebook_content: String,
client_index: i32
) -> Result<String>
&self,
to_profile_id: String,
fcm_content: String,
ios_content: String,
facebook_content: String,
client_index: i32
) -> Result<String>
Sends a raw push notification to a target user.
fn handle_push_notification_send_raw_push_notification_batch(
&self,
profile_ids: Vec<String>,
fcm_content: String,
ios_content: String,
facebook_content: String,
client_index: i32
) -> Result<String>
&self,
profile_ids: Vec<String>,
fcm_content: String,
ios_content: String,
facebook_content: String,
client_index: i32
) -> Result<String>
Sends a raw push notification to a target list of users.
fn handle_push_notification_send_raw_push_notification_to_group(
&self,
group_id: String,
fcm_content: String,
ios_content: String,
facebook_content: String,
client_index: i32
) -> Result<String>
&self,
group_id: String,
fcm_content: String,
ios_content: String,
facebook_content: String,
client_index: i32
) -> Result<String>
Sends a raw push notification to a target group.
fn handle_push_notification_schedule_normalized_push_notification_u_t_c(
&self,
profile_id: String,
alert_content_json: String,
custom_data_json: String,
start_time: i32,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
alert_content_json: String,
custom_data_json: String,
start_time: i32,
client_index: i32
) -> Result<String>
Schedules a normalized push notification to a user
fn handle_push_notification_schedule_normalized_push_notification_minutes(
&self,
profile_id: String,
alert_content_json: String,
custom_data_json: String,
minutes_from_now: i32,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
alert_content_json: String,
custom_data_json: String,
minutes_from_now: i32,
client_index: i32
) -> Result<String>
Schedules a normalized push notification to a user
fn handle_push_notification_schedule_rich_push_notification_u_t_c(
&self,
profile_id: String,
notification_template_id: i32,
substitutions_json: String,
start_time: i32,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
notification_template_id: i32,
substitutions_json: String,
start_time: i32,
client_index: i32
) -> Result<String>
Schedules a rich push notification to a user
fn handle_push_notification_schedule_rich_push_notification_minutes(
&self,
profile_id: String,
notification_template_id: i32,
substitutions_json: String,
minutes_from_now: i32,
client_index: i32
) -> Result<String>
&self,
profile_id: String,
notification_template_id: i32,
substitutions_json: String,
minutes_from_now: i32,
client_index: i32
) -> Result<String>
Schedules a rich push notification to a user
fn handle_push_notification_send_normalized_push_notification(
&self,
to_profile_id: String,
alert_content_json: String,
custom_data_json: String,
client_index: i32
) -> Result<String>
&self,
to_profile_id: String,
alert_content_json: String,
custom_data_json: String,
client_index: i32
) -> Result<String>
Sends a notification to a user consisting of alert content and custom data.
fn handle_push_notification_send_normalized_push_notification_batch(
&self,
profile_ids: Vec<String>,
alert_content_json: String,
custom_data_json: String,
client_index: i32
) -> Result<String>
&self,
profile_ids: Vec<String>,
alert_content_json: String,
custom_data_json: String,
client_index: i32
) -> Result<String>
Sends a notification to multiple users consisting of alert content and custom data.
fn handle_script_run_script(
&self,
script_name: String,
json_script_data: String,
client_index: i32
) -> Result<String>
&self,
script_name: String,
json_script_data: String,
client_index: i32
) -> Result<String>
Executes a script on the server.
fn handle_script_schedule_run_script_u_t_c(
&self,
script_name: String,
json_script_data: String,
start_date_in_u_t_c: date,
client_index: i32
) -> Result<String>
&self,
script_name: String,
json_script_data: String,
start_date_in_u_t_c: date,
client_index: i32
) -> Result<String>
Allows cloud script executions to be scheduled
fn handle_script_schedule_run_script_minutes(
&self,
script_name: String,
json_script_data: String,
minutes_from_now: i64,
client_index: i32
) -> Result<String>
&self,
script_name: String,
json_script_data: String,
minutes_from_now: i64,
client_index: i32
) -> Result<String>
Allows cloud script executions to be scheduled
fn handle_script_run_parent_script(
&self,
script_name: String,
json_script_data: String,
parent_level: String,
client_index: i32
) -> Result<String>
&self,
script_name: String,
json_script_data: String,
parent_level: String,
client_index: i32
) -> Result<String>
Run a cloud script in a parent app
fn handle_script_cancel_scheduled_script(
&self,
job_id: String,
client_index: i32
) -> Result<String>
&self,
job_id: String,
client_index: i32
) -> Result<String>
Cancels a scheduled cloud code script
fn handle_script_run_peer_script(
&self,
script_name: String,
json_script_data: String,
peer: String,
client_index: i32
) -> Result<String>
&self,
script_name: String,
json_script_data: String,
peer: String,
client_index: i32
) -> Result<String>
Runs a script from the context of a peer
fn handle_script_run_peer_script_asynch(
&self,
script_name: String,
json_script_data: String,
peer: String,
client_index: i32
) -> Result<String>
&self,
script_name: String,
json_script_data: String,
peer: String,
client_index: i32
) -> Result<String>
Runs a script asynchronously from the context of a peer This operation does not wait for the script to complete before returning
fn handle_social_leaderboard_get_social_leaderboard(
&self,
leaderboard_id: String,
replace_name: bool,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
replace_name: bool,
client_index: i32
) -> Result<String>
Method returns the social leaderboard. A player's social leaderboard is comprised of players who are recognized as being your friend. For now, this applies solely to Facebook connected players who are friends with the logged in player (who also must be Facebook connected). In the future this will expand to other identification means (such as Game Centre, Google circles etc).
Leaderboards entries contain the player's score and optionally, some user-defined data associated with the score. The currently logged in player will also be returned in the social leaderboard.
Note: If no friends have played the game, the bestScore, createdAt, updatedAt will contain NULL.
fn handle_social_leaderboard_get_multi_social_leaderboard(
&self,
leaderboard_ids: Vec<String>,
leaderboard_result_count: i32,
replace_name: bool,
client_index: i32
) -> Result<String>
&self,
leaderboard_ids: Vec<String>,
leaderboard_result_count: i32,
replace_name: bool,
client_index: i32
) -> Result<String>
Reads multiple social leaderboards.
fn handle_social_leaderboard_get_global_leaderboard_page(
&self,
leaderboard_id: String,
sort: SortOrder,
start_index: i32,
end_index: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
sort: SortOrder,
start_index: i32,
end_index: i32,
client_index: i32
) -> Result<String>
Method returns a page of global leaderboard results.
Leaderboards entries contain the player's score and optionally, some user-defined data associated with the score.
Note: This method allows the client to retrieve pages from within the global leaderboard list
fn handle_social_leaderboard_get_global_leaderboard_page_by_version(
&self,
leaderboard_id: String,
sort: SortOrder,
start_index: i32,
end_index: i32,
version_id: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
sort: SortOrder,
start_index: i32,
end_index: i32,
version_id: i32,
client_index: i32
) -> Result<String>
Method returns a page of global leaderboard results. By using a non-current version id, the user can retrieve a historical leaderboard. See GetGlobalLeaderboardVersions method to retrieve the version id.
fn handle_social_leaderboard_get_global_leaderboard_view(
&self,
leaderboard_id: String,
sort: SortOrder,
before_count: i32,
after_count: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
sort: SortOrder,
before_count: i32,
after_count: i32,
client_index: i32
) -> Result<String>
Method returns a view of global leaderboard results that centers on the current player.
Leaderboards entries contain the player's score and optionally, some user-defined data associated with the score.
fn handle_social_leaderboard_get_global_leaderboard_view_by_version(
&self,
leaderboard_id: String,
sort: SortOrder,
before_count: i32,
after_count: i32,
version_id: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
sort: SortOrder,
before_count: i32,
after_count: i32,
version_id: i32,
client_index: i32
) -> Result<String>
Method returns a view of global leaderboard results that centers on the current player. By using a non-current version id, the user can retrieve a historical leaderboard. See GetGlobalLeaderboardVersions method to retrieve the version id.
fn handle_social_leaderboard_get_global_leaderboard_versions(
&self,
leaderboard_id: String,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
client_index: i32
) -> Result<String>
Gets the global leaderboard versions.
fn handle_social_leaderboard_get_group_social_leaderboard(
&self,
leaderboard_id: String,
group_id: String,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
group_id: String,
client_index: i32
) -> Result<String>
Retrieve the social leaderboard for a group.
fn handle_social_leaderboard_post_score_to_leaderboard(
&self,
leaderboard_id: String,
score: i64,
json_data: String,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
score: i64,
json_data: String,
client_index: i32
) -> Result<String>
Post the players score to the given social leaderboard. You can optionally send a user-defined json string of data with the posted score. This string could include information relevant to the posted score.
Note that the behaviour of posting a score can be modified in the brainCloud portal. By default, the server will only keep the player's best score.
fn handle_social_leaderboard_remove_player_score(
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
Removes a player's score from the leaderboard
fn handle_social_leaderboard_post_score_to_dynamic_leaderboard(
&self,
leaderboard_id: String,
score: i64,
json_data: String,
leaderboard_type: SocialLeaderboardType,
rotation_type: RotationType,
rotation_reset: date,
retained_count: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
score: i64,
json_data: String,
leaderboard_type: SocialLeaderboardType,
rotation_type: RotationType,
rotation_reset: date,
retained_count: i32,
client_index: i32
) -> Result<String>
Post the players score to the given social leaderboard. Pass leaderboard config data to dynamically create if necessary. You can optionally send a user-defined json string of data with the posted score. This string could include information relevant to the posted score.
fn handle_social_leaderboard_post_score_to_dynamic_leaderboard_days(
&self,
leaderboard_id: String,
score: i64,
json_data: String,
leaderboard_type: SocialLeaderboardType,
rotation_reset: date,
retained_count: i32,
num_days_to_rotate: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
score: i64,
json_data: String,
leaderboard_type: SocialLeaderboardType,
rotation_reset: date,
retained_count: i32,
num_days_to_rotate: i32,
client_index: i32
) -> Result<String>
Post the players score to the given social leaderboard with a rotation type of DAYS. Pass leaderboard config data to dynamically create if necessary. You can optionally send a user-defined json string of data with the posted score. This string could include information relevant to the posted score.
fn handle_social_leaderboard_get_players_social_leaderboard(
&self,
leaderboard_id: String,
profile_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
profile_ids: Vec<String>,
client_index: i32
) -> Result<String>
Retrieve the social leaderboard for a list of players.
fn handle_social_leaderboard_list_leaderboards(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
Retrieve a list of all leaderboards
fn handle_social_leaderboard_get_global_leaderboard_entry_count(
&self,
leaderboard_id: String,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
client_index: i32
) -> Result<String>
Gets the number of entries in a global leaderboard
fn handle_social_leaderboard_get_global_leaderboard_entry_count_by_version(
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
Gets the number of entries in a global leaderboard
fn handle_social_leaderboard_get_player_score(
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
Gets a player's score from a leaderboard
fn handle_social_leaderboard_get_player_scores_from_leaderboards(
&self,
leaderboard_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
leaderboard_ids: Vec<String>,
client_index: i32
) -> Result<String>
Gets a player's score from multiple leaderboards
fn handle_time_read_server_time(&self, client_index: i32) -> Result<String>
Method returns the server time in UTC. This is in UNIX millis time format. For instance 1396378241893 represents 2014-04-01 2:50:41.893 in GMT-4.
fn handle_tournament_claim_tournament_reward(
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
Processes any outstanding rewards for the given player
fn handle_tournament_get_tournament_status(
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
Get tournament status associated with a leaderboard
fn handle_tournament_join_tournament(
&self,
leaderboard_id: String,
tournament_code: String,
initial_score: i64,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
tournament_code: String,
initial_score: i64,
client_index: i32
) -> Result<String>
Join the specified tournament. Any entry fees will be automatically collected.
fn handle_tournament_leave_tournament(
&self,
leaderboard_id: String,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
client_index: i32
) -> Result<String>
Removes player's score from tournament leaderboard
fn handle_tournament_post_tournament_score(
&self,
leaderboard_id: String,
score: i64,
json_data: String,
round_started_time: date,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
score: i64,
json_data: String,
round_started_time: date,
client_index: i32
) -> Result<String>
Post the users score to the leaderboard
fn handle_tournament_post_tournament_score_with_results(
&self,
leaderboard_id: String,
score: i64,
json_data: String,
round_started_time: date,
sort: SortOrder,
before_count: i32,
after_count: i32,
initial_score: i64,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
score: i64,
json_data: String,
round_started_time: date,
sort: SortOrder,
before_count: i32,
after_count: i32,
initial_score: i64,
client_index: i32
) -> Result<String>
Post the users score to the leaderboard and returns the results
fn handle_tournament_view_current_reward(
&self,
leaderboard_id: String,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
client_index: i32
) -> Result<String>
Returns the user's expected reward based on the current scores
fn handle_tournament_view_reward(
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
&self,
leaderboard_id: String,
version_id: i32,
client_index: i32
) -> Result<String>
Returns the user's reward from a finished tournament
fn handle_lobby_create_lobby(
&self,
lobby_type: LobbyType,
max_slots: i32,
is_open: bool,
json_attributes: String,
client_index: i32
) -> Result<String>
&self,
lobby_type: LobbyType,
max_slots: i32,
is_open: bool,
json_attributes: String,
client_index: i32
) -> Result<String>
Create a new lobby.
fn handle_lobby_open_lobby(
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
Open a lobby so players can join.
fn handle_lobby_close_lobby(
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
Close a lobby so players can't join.
fn handle_lobby_find_lobbies(
&self,
free_slots: i32,
max_results: i32,
json_attributes: String,
client_index: i32
) -> Result<String>
&self,
free_slots: i32,
max_results: i32,
json_attributes: String,
client_index: i32
) -> Result<String>
Find lobbies the player can join.
fn handle_lobby_find_friends_lobbies(&self, client_index: i32) -> Result<String>
Find lobbies with the player's friends in them.
fn handle_lobby_join_lobby(
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
Join a lobby.
fn handle_lobby_leave_lobby(
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
Leave a lobby.
fn handle_lobby_destroy_lobby(
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
&self,
lobby_id: String,
client_index: i32
) -> Result<String>
Destroy a lobby.
fn handle_lobby_start_game(
&self,
lobby_id: String,
connection_string: String,
client_index: i32
) -> Result<String>
&self,
lobby_id: String,
connection_string: String,
client_index: i32
) -> Result<String>
Start a lobby game.
fn handle_lobby_get_my_lobbies(&self, client_index: i32) -> Result<String>
Get a list of lobbies the player is a member of.
fn handle_party_accept_party_invitation(
&self,
party_id: String,
client_index: i32
) -> Result<String>
&self,
party_id: String,
client_index: i32
) -> Result<String>
fn handle_party_get_party_info(
&self,
party_id: String,
client_index: i32
) -> Result<String>
&self,
party_id: String,
client_index: i32
) -> Result<String>
fn handle_party_join_party(
&self,
party_id: String,
client_index: i32
) -> Result<String>
&self,
party_id: String,
client_index: i32
) -> Result<String>
fn handle_party_leave_party(
&self,
party_id: String,
client_index: i32
) -> Result<String>
&self,
party_id: String,
client_index: i32
) -> Result<String>
fn handle_party_reject_party_invitation(
&self,
party_id: String,
client_index: i32
) -> Result<String>
&self,
party_id: String,
client_index: i32
) -> Result<String>
fn handle_party_send_party_invitation(
&self,
player_id: String,
client_index: i32
) -> Result<String>
&self,
player_id: String,
client_index: i32
) -> Result<String>
fn handle_party_list_party_invitations(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
fn handle_party_get_friends_parties(
&self,
max_results: i32,
client_index: i32
) -> Result<String>
&self,
max_results: i32,
client_index: i32
) -> Result<String>
fn handle_party_get_my_party(&self, client_index: i32) -> Result<String>
fn handle_patch_get_game_manifest(
&self,
game_id: String,
client_index: i32
) -> Result<String>
&self,
game_id: String,
client_index: i32
) -> Result<String>
fn handle_shopping_add_to_cart_s_i_s_f_o(
&self,
product_id: String,
quantity: i32,
client_index: i32
) -> Result<String>
&self,
product_id: String,
quantity: i32,
client_index: i32
) -> Result<String>
Add a product to the player's shopping cart.
fn handle_shopping_add_to_cart_i_s_f_o(
&self,
product_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
product_ids: Vec<String>,
client_index: i32
) -> Result<String>
Add a product to the player's shopping cart.
fn handle_shopping_empty_cart(&self, client_index: i32) -> Result<String>
Empty the player's shopping cart.
fn handle_shopping_get_cart(
&self,
include_details: bool,
client_index: i32
) -> Result<String>
&self,
include_details: bool,
client_index: i32
) -> Result<String>
Retrieve the player's current shopping cart.
fn handle_shopping_remove_from_cart(
&self,
product_id: String,
quantity: i32,
client_index: i32
) -> Result<String>
&self,
product_id: String,
quantity: i32,
client_index: i32
) -> Result<String>
Remove an item from the player's shopping cart.
fn handle_shopping_add_to_wishlist(
&self,
product_id: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
client_index: i32
) -> Result<String>
Add an item to the player's wishlist.
fn handle_shopping_empty_wishlist(&self, client_index: i32) -> Result<String>
Remove all items from the player's wishlist.
fn handle_shopping_get_my_wishlist(
&self,
include_details: bool,
client_index: i32
) -> Result<String>
&self,
include_details: bool,
client_index: i32
) -> Result<String>
Returns the current player's wishlist.
fn handle_shopping_get_wishlist(
&self,
player_id: String,
include_details: bool,
client_index: i32
) -> Result<String>
&self,
player_id: String,
include_details: bool,
client_index: i32
) -> Result<String>
Returns the specified player's wishlist.
fn handle_shopping_remove_from_wishlist_s_s_f_o(
&self,
product_id: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
client_index: i32
) -> Result<String>
Remove an item from the player's wishlist.
fn handle_shopping_remove_from_wishlist_i_s_f_o(
&self,
product_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
product_ids: Vec<String>,
client_index: i32
) -> Result<String>
Remove multiple items from the player's wishlist.
fn handle_shopping_get_user_reviews(
&self,
product_id: String,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
product_id: String,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
Get a list of user reviews for a product.
fn handle_shopping_submit_user_review(
&self,
product_id: String,
review_text: String,
positive: bool,
client_index: i32
) -> Result<String>
&self,
product_id: String,
review_text: String,
positive: bool,
client_index: i32
) -> Result<String>
Submit a user review of a product.
fn handle_shopping_like_user_review(
&self,
product_id: String,
review_id: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
review_id: String,
client_index: i32
) -> Result<String>
@3972606582
fn handle_shopping_unlike_user_review(
&self,
product_id: String,
review_id: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
review_id: String,
client_index: i32
) -> Result<String>
@594218927
fn handle_shopping_funny_user_review(
&self,
product_id: String,
review_id: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
review_id: String,
client_index: i32
) -> Result<String>
@2222188570
fn handle_shopping_unfunny_user_review(
&self,
product_id: String,
review_id: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
review_id: String,
client_index: i32
) -> Result<String>
@2806051775
fn handle_shopping_get_recently_created_products(
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
Return a list of recently created products.
fn handle_shopping_get_recently_updated_products(
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
Return a list of recently updated products.
fn handle_shopping_get_featured_products(
&self,
include_details: bool,
client_index: i32
) -> Result<String>
&self,
include_details: bool,
client_index: i32
) -> Result<String>
Return a list of featured products.
fn handle_shopping_get_popular_products(
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
Return a list of the mos tpopular products.
fn handle_shopping_get_special_offers(
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
Return a list of special offers.
fn handle_shopping_get_my_library(
&self,
include_details: bool,
client_index: i32
) -> Result<String>
&self,
include_details: bool,
client_index: i32
) -> Result<String>
@2304250631
fn handle_shopping_get_popular_tags(
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
@1350446922
fn handle_shopping_get_products_by_tag(
&self,
tag: String,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
tag: String,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
@3387279661
fn handle_shopping_get_products_by_tags(
&self,
tags: Vec<String>,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
tags: Vec<String>,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
@2681224790
fn handle_shopping_get_recommended_products(
&self,
count: i32,
client_index: i32
) -> Result<String>
&self,
count: i32,
client_index: i32
) -> Result<String>
@2681224790
fn handle_shopping_get_my_orders(
&self,
include_completed: bool,
client_index: i32
) -> Result<String>
&self,
include_completed: bool,
client_index: i32
) -> Result<String>
@919332756
fn handle_shopping_get_product(
&self,
product_id: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
client_index: i32
) -> Result<String>
@2681224790
fn handle_shopping_get_user_tags(
&self,
product_id: String,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
&self,
product_id: String,
page: i32,
page_size: i32,
client_index: i32
) -> Result<String>
@1777617418
fn handle_shopping_get_my_user_tags(
&self,
product_id: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
client_index: i32
) -> Result<String>
@274383141
fn handle_shopping_submit_user_tag(
&self,
product_id: String,
tag: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
tag: String,
client_index: i32
) -> Result<String>
@3717774610
fn handle_shopping_submit_user_tags(
&self,
product_id: String,
tags: Vec<String>,
client_index: i32
) -> Result<String>
&self,
product_id: String,
tags: Vec<String>,
client_index: i32
) -> Result<String>
@3717774610
fn handle_shopping_remove_user_tag(
&self,
product_id: String,
tag: String,
client_index: i32
) -> Result<String>
&self,
product_id: String,
tag: String,
client_index: i32
) -> Result<String>
@2944656417
fn handle_social_feed_share_video(
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
fn handle_social_feed_share_screenshot(
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
fn handle_social_feed_share_achievement(
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
fn handle_social_feed_share_app(
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
fn handle_social_feed_share_channel(
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
fn handle_social_feed_share_link(
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
fn handle_social_feed_share_game_guide(
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
resource: String,
tagged: Vec<String>,
show: Vec<String>,
block: Vec<String>,
client_index: i32
) -> Result<String>
fn handle_social_feed_read_social_feed(
&self,
skip: i32,
limit: i32,
client_index: i32
) -> Result<String>
&self,
skip: i32,
limit: i32,
client_index: i32
) -> Result<String>
fn handle_social_feed_read_filtered_social_feed(
&self,
skip: i32,
limit: i32,
player_ids: Vec<String>,
client_index: i32
) -> Result<String>
&self,
skip: i32,
limit: i32,
player_ids: Vec<String>,
client_index: i32
) -> Result<String>
fn handle_social_feed_read_friends_social_feed(
&self,
skip: i32,
limit: i32,
client_index: i32
) -> Result<String>
&self,
skip: i32,
limit: i32,
client_index: i32
) -> Result<String>
fn handle_social_feed_post_comment(
&self,
timestamp: i32,
parent_id: String,
content: String,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
parent_id: String,
content: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_post_comment_reply(
&self,
timestamp: i32,
parent_id: String,
content: String,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
parent_id: String,
content: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_read_comments(
&self,
skip: i32,
limit: i32,
parent_id: String,
client_index: i32
) -> Result<String>
&self,
skip: i32,
limit: i32,
parent_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_read_comment_replies(
&self,
skip: i32,
limit: i32,
parent_id: String,
client_index: i32
) -> Result<String>
&self,
skip: i32,
limit: i32,
parent_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_like_comment(
&self,
social_feed_id: String,
client_index: i32
) -> Result<String>
&self,
social_feed_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_like_activity(
&self,
social_feed_id: String,
client_index: i32
) -> Result<String>
&self,
social_feed_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_unlike_comment(
&self,
social_feed_id: String,
client_index: i32
) -> Result<String>
&self,
social_feed_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_unlike_activity(
&self,
social_feed_id: String,
client_index: i32
) -> Result<String>
&self,
social_feed_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_set_feed_visibility(
&self,
visibility: String,
client_index: i32
) -> Result<String>
&self,
visibility: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_block_player(
&self,
player_id: String,
client_index: i32
) -> Result<String>
&self,
player_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_hide_player(
&self,
player_id: String,
client_index: i32
) -> Result<String>
&self,
player_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_unblock_player(
&self,
player_id: String,
client_index: i32
) -> Result<String>
&self,
player_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_unhide_player(
&self,
player_id: String,
client_index: i32
) -> Result<String>
&self,
player_id: String,
client_index: i32
) -> Result<String>
fn handle_social_feed_get_activity(
&self,
social_feed_id: String,
depth: i32,
skip: i32,
limit: i32,
client_index: i32
) -> Result<String>
&self,
social_feed_id: String,
depth: i32,
skip: i32,
limit: i32,
client_index: i32
) -> Result<String>
fn handle_social_feed_get_comment(
&self,
social_feed_id: String,
depth: i32,
skip: i32,
limit: i32,
client_index: i32
) -> Result<String>
&self,
social_feed_id: String,
depth: i32,
skip: i32,
limit: i32,
client_index: i32
) -> Result<String>
fn handle_telemetry_start_telemetry_session(
&self,
timestamp: i32,
client_index: i32
) -> Result<String>
&self,
timestamp: i32,
client_index: i32
) -> Result<String>
fn handle_telemetry_end_telemetry_session(
&self,
telemetry_session_id: String,
timestamp: i32,
client_index: i32
) -> Result<String>
&self,
telemetry_session_id: String,
timestamp: i32,
client_index: i32
) -> Result<String>
fn handle_telemetry_log_telemetry_event(
&self,
telemetry_session_id: String,
timestamp: i32,
event_type: String,
participant_id: String,
custom_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
&self,
telemetry_session_id: String,
timestamp: i32,
event_type: String,
participant_id: String,
custom_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
fn handle_telemetry_start_telemetry_event(
&self,
telemetry_session_id: String,
timestamp: i32,
event_type: String,
participant_id: String,
custom_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
&self,
telemetry_session_id: String,
timestamp: i32,
event_type: String,
participant_id: String,
custom_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
fn handle_telemetry_end_telemetry_event(
&self,
telemetry_session_id: String,
timestamp: i32,
event_type: String,
participant_id: String,
custom_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
&self,
telemetry_session_id: String,
timestamp: i32,
event_type: String,
participant_id: String,
custom_data: BTreeMap<String, JSON>,
client_index: i32
) -> Result<String>
fn handle_authentication_get_we_chat_q_r_page_u_r_l(
&self,
client_index: i32
) -> Result<String>
&self,
client_index: i32
) -> Result<String>
@Authentication_GetWeChatQRPageURL_desc
fn handle_file_download_file(
&self,
cloud_path: String,
cloud_filename: String,
replace_if_exists: bool,
client_index: i32
) -> Result<String>
&self,
cloud_path: String,
cloud_filename: String,
replace_if_exists: bool,
client_index: i32
) -> Result<String>
@BrainCloud_DownloadFile_desc
fn handle_file_get_download_info(
&self,
cloud_path: String,
cloud_filename: String,
client_index: i32
) -> Result<String>
&self,
cloud_path: String,
cloud_filename: String,
client_index: i32
) -> Result<String>
@BrainCloud_GetDownloadInfo_desc
fn handle_file_cancel_download(
&self,
cloud_path: String,
cloud_filename: String,
client_index: i32
) -> Result<String>
&self,
cloud_path: String,
cloud_filename: String,
client_index: i32
) -> Result<String>
@BrainCloud_CancelDownload_desc