 | Ruyi.SDK.Online Namespace |
[This is preliminary documentation and is subject to change.]
Ruyi.SDK.Online namespace provides access to online services. Most functionality is available via a RuyiNetClient instance.
Classes| Class | Description | |
|---|---|---|
 | RuyiNetAchievement |
Represents an achievement in RuyiNet
|
| RuyiNetAchievementResponse |
Response recieved from an achievemet request (gamification service).
|
| RuyiNetAchievementResponseData |
The data class.
|
| RuyiNetAchievementResponseDataAchievement |
Represents an achievement
|
| RuyiNetAcl |
Determines the permissions others have to access a players entities
(0 = no access, 1 = read-only, 2 = read/write).
|
 | RuyiNetClient |
The main client for accessing Ruyi's online services (aka "RuyiNet")
|
| RuyiNetCloudService |
Handles backing up data to the cloud.
|
| RuyiNetEntity |
Represents an entity
|
| RuyiNetEntityData |
Represents entity data that comes from a response.
|
| RuyiNetFriendFindUsersResponse |
Represents a response from a Find Users Response.
|
| RuyiNetFriendFindUsersResponseData |
Represents the response data.
|
| RuyiNetFriendGetUsersOnlineStatusResponse |
Represents a response from a Get Users Online Status request.
|
| RuyiNetFriendGetUsersOnlineStatusResponseData |
Represents the response data.,
|
| RuyiNetFriendInvite |
Represents a friend invitation.
|
| RuyiNetFriendListInvitationsResponse |
Response recieved from a List Invitations request.
|
| RuyiNetFriendListInvitationsResponseData |
Represents the response data.
|
| RuyiNetFriendOnlineStatus |
Represents a player's online status.
|
| RuyiNetFriendResponseInvite |
Represents the data from a List Invites request.
|
| RuyiNetFriendResponseOnlineStatus |
Represents data from a Get Users Status response.
|
| RuyiNetFriendResponseSummaryData |
Represents summary data from a response.
|
| RuyiNetFriendService |
A service for handling players' friend lists.
|
| RuyiNetFriendSummaryData |
Represents the summary data for a friend.
|
| RuyiNetGameManifest |
A Game Manifest that includes patch information.
|
| RuyiNetGameManifestPatch |
Represents a game patch.
|
| RuyiNetGamificationService |
Provides gamification services to a game.
|
| RuyiNetGetCDNResponse |
The response from getting a CDN
|
| RuyiNetGetCDNResponseData |
The response data.
|
| RuyiNetGetFriendsVideosResponse |
The response from GetFriendsVideos
|
| RuyiNetGetFriendsVideosResponseData |
The response data.
|
| RuyiNetGetFriendsVideosResponseDataEntity |
A single returned entity.
|
| RuyiNetGetGameManifestResponse |
Response from making a call to brainCloud.
|
| RuyiNetGetGameManifestResponseData |
Response data.
|
| RuyiNetGetGameManifestResponseDataPatch |
Represents a game patch.
|
| RuyiNetGetGlobalLeaderboardEntryCountResponse |
Response recieved from an achievemet request (gamification service).
|
| RuyiNetGetGlobalLeaderboardEntryCountResponseData |
The data class.
|
| RuyiNetGetGlobalLeaderboardPageResponse |
Response recieved from an achievemet request (gamification service).
|
| RuyiNetGetGlobalLeaderboardPageResponseData |
The data class.
|
| RuyiNetGetGlobalLeaderboardPageResponseDataLeaderboardEntry |
Represents a single leaderboard entry.
|
| RuyiNetGetGlobalLeaderboardVersionsResponse |
Represents a response from a GetLeaderboardVersions request.
|
| RuyiNetGetGlobalLeaderboardVersionsResponseData |
The data class.
|
| RuyiNetGetGlobalLeaderboardVersionsResponseDataVersionInfo |
Represents a leaderboard version.
|
| RuyiNetGetGroupSocialLeaderboardResponse |
Response recieved from retrieving a social leaderboard.
|
| RuyiNetGetGroupSocialLeaderboardResponseData |
The data class.
|
| RuyiNetGetGroupSocialLeaderboardResponseDataLeaderboardEntry |
Represents a single leaderboard entry.
|
| RuyiNetGetPlayerScoreResponse |
Response recieved from retrieving a player's score.
|
| RuyiNetGetPlayerScoreResponseData |
The data class.
|
| RuyiNetGetPlayerScoreResponseDataScore |
Represents a player score.
|
| RuyiNetGetPlayerScoresFromLeaderboardsResponse |
Response recieved from retrieving a player's scores.
|
| RuyiNetGetPlayerScoresFromLeaderboardsResponseData |
The data class.
|
| RuyiNetGetPlayerScoresFromLeaderboardsResponseDataScore |
Represents a player score.
|
| RuyiNetGetProfileResponse |
The response after a single profile is requested.
|
| RuyiNetGetProfileResponseData |
The data contained in the response.
|
| RuyiNetGetProfilesResponse |
The response after a list of profiles are requested.
|
| RuyiNetGetProfilesResponseData |
The data contained in the response.
|
| RuyiNetGetSocialLeaderboardResponse |
Response recieved from retrieving a social leaderboard.
|
| RuyiNetGetSocialLeaderboardResponseData |
The data class.
|
| RuyiNetGetSocialLeaderboardResponseDataLeaderboardEntry |
Represents a single leaderboard entry.
|
| RuyiNetGetSummaryDataForProfileIdResponse |
Represents a response from a Get Summary Data request.
|
| RuyiNetGetSummaryDataMultipleResponse |
Represents a response from a Find Users Response.
|
| RuyiNetGetSummaryDataMultipleResponseData |
Represents the response data.
|
| RuyiNetHttpStatus |
Status codes returned from RuyiNet operations.
|
| RuyiNetLeaderboardConfig |
Represents a leaderboard configuration.
|
| RuyiNetLeaderboardEntry |
Represents a single leaderboard entry.
|
| RuyiNetLeaderboardInfo |
Represents a leaderboard on RuyiNet.
|
| RuyiNetLeaderboardPage |
Represents a single page retrieved from a leaderboard.
|
| RuyiNetLeaderboardService |
Provides operations to retrieve leaderboard data and submit scores.
|
| RuyiNetLeaderboardVersionInfo |
Represents a leaderboard version.
|
| RuyiNetListAllLeaderboardsResponse |
Response recieved from an achievemet request (gamification service).
|
| RuyiNetListAllLeaderboardsResponseData |
The data class.
|
| RuyiNetListAllLeaderboardsResponseDataLeaderboardInfo |
Represents a single leaderboard config.
|
| RuyiNetListFriendsResponse |
The response after a friend list is requested.
|
| RuyiNetListFriendsResponseData |
The response data.
|
| RuyiNetListUserFilesResponse |
The response from a List User Files request.
|
| RuyiNetListUserFilesResponseData |
The response data.
|
| RuyiNetListUserFilesResponseDataFileDetails |
The details of the file to upload.
|
| RuyiNetLobby |
A lobby used in matchmaking for multiplayer games.
|
| RuyiNetLobbyFindResponse |
The response recieved on finding a lobby.
|
| RuyiNetLobbyFindResponseData |
The data
|
| RuyiNetLobbyResponse |
Response received after creating a lobby.
|
| RuyiNetLobbyResponseData |
The response data included with responses from the Lobby API.
|
| RuyiNetLobbyService |
Manages lobbies for network games.
|
| RuyiNetParty |
Represents a Party.
|
| RuyiNetPartyData |
Represents party data returned from a response.
|
| RuyiNetPartyInvitation |
Represents a party invitation.
|
| RuyiNetPartyInvitationData |
Represents invitation data from a party response.
|
| RuyiNetPartyInvitationResponse |
Represents a response from a list party invitation request.
|
| RuyiNetPartyInvitationResponseData |
Represents the response data.
|
| RuyiNetPartyListResponse |
Represents a response from a party list request.
|
| RuyiNetPartyListResponseData |
Represents the response data.
|
| RuyiNetPartyResponse |
Represents a response from a party service request
|
| RuyiNetPartyResponseData |
Represents the response data.
|
| RuyiNetPartyService |
Allows players to gather together in a party.
|
| RuyiNetPatchService |
Get Game Manifest information for patches.
|
| RuyiNetPlatformTaskResponse |
A task that is called on the platform (RUYI) API rather than the game's API.
|
| RuyiNetPlayerScore |
Represents a player's score on a leaderboard.
|
| RuyiNetProfile |
A profile that can be returned from Ruyi Net operations.
|
| RuyiNetProfileService |
Methods to help a player manage their profile.
|
| RuyiNetReadFriendEntityResponse |
Response from a Read Friend Entity request.
|
| RuyiNetReadFriendsEntitiesResponse |
Represents a response from a Read Friends Entities request.
|
| RuyiNetReadFriendsEntitiesResponseData |
Represents the response data.
|
| RuyiNetResponse |
Simple class for receiving status responses from API calls.
|
| RuyiNetResponseGroup |
A group received from a response.
|
| RuyiNetResponseGroupACL |
Access Control List
|
| RuyiNetResponseGroupData |
Extra custom data
|
| RuyiNetResponseGroupDefaultMemberAttributes |
The default attributes for members.
|
| RuyiNetResponseGroupMember |
A group member.
|
| RuyiNetResponseGroupMemberAttributes |
Attributes that can be attached to the member.
|
| RuyiNetService |
Base class for all Net Services.
|
| RuyiNetSummaryFriendData |
The summary data of the player.
|
| RuyiNetTaskResponse |
A task that is used to make a request to RuyiNet.
|
| RuyiNetTaskBase |
Base class for tasks.
|
| RuyiNetTelemetryService |
Handles pushing telemetry data to the cloud.
|
| RuyiNetTelemetrySession |
Represents a telemetry session.
|
| RuyiNetTelemetrySessionResponse |
Response recieved after making a telemetry session request.
|
| RuyiNetTelemetrySessionResponseData |
The data class.
|
| RuyiNetUploadFileResponse |
The response after uploading a file.
|
| RuyiNetUploadFileResponseData |
The response data.
|
| RuyiNetUploadFileResponseDataFileDetails |
The details of the file to upload.
|
| RuyiNetUserFileService |
Allows users to upload files to their individual accounts
|
| RuyiNetVideo |
Represents a video entity.
|
| RuyiNetVideoService |
Allows users to upload videos to their individual accounts.
TODO: about the file upload/download, we need a second solution like still
transfer the whole file from SDK to Layer0, because we need to use the SDK on mobile,
we can identify this kind of situation from the SDKContext.
|
Delegates| Delegate | Description | |
|---|---|---|
 | RuyiNetLobbyServiceLobbyClosedEvent |
Prototype for a Lobby Closed callback.
|
| RuyiNetLobbyServiceLobbyCreatedEvent |
Prototype for a Lobby Created Callback.
|
| RuyiNetLobbyServiceLobbyDestroyedEvent |
Prototype for a Lobby destroyed callback.
|
| RuyiNetLobbyServiceLobbyGameStartedEvent |
Prototype for a Lobby Game Started callback.
|
| RuyiNetLobbyServiceLobbyOpenedEvent |
Prototype for a Lobby Opened callback.
|
| RuyiNetLobbyServiceLobbyPlayerJoinedEvent |
Prototype for a Lobby Player Joined callback.
|
| RuyiNetLobbyServiceLobbyPlayerLeftEvent |
Prototype for a Lobby Player Left callback.
|
| RuyiNetTaskResponseCallbackType |
Prototype of a callback for the task.
|
| RuyiNetTaskResponseExecuteType |
Prototype for a method to be called that makes a request to RuyiNet.
|
Enumerations| Enumeration | Description | |
|---|---|---|
 | RuyiNetAchievementStatus |
Status of an achievement for the player
|
| RuyiNetLeaderboardType |
The type of a leaderboard.
|
| RuyiNetLobbyState |
The current state of a lobby.
|
| RuyiNetLobbyType |
The type of the lobby: Ranked or Player match.
|
| RuyiNetRotationType |
How often a leaderboard will reset.
|