CotC C# SDK for Unity  v1.4.0.1
Making social games is easy !
All Classes Namespaces Functions Variables Enumerations Enumerator Properties Modules Pages
Namespaces | Classes | Enumerations | Functions
CotcSdk Namespace Reference

Classes

class  AchievementDefinition
 Definition of an achievement. Achievements are inputted on the backoffice and are triggered under defined circumstances. More...
 
class  Bundle
 The bundle is a main concept of the CotC SDK. It is basically the equivalent of a JSON object, behaving like a C# dictionary, but with inferred typing and more safety. More...
 
struct  CachedMember
 Holds a cached single-time-instantiated member. More...
 
class  Cloud
 Root class of the SDK. It is stateless and allows to perform basic operations with the SDK, such as Ping. More...
 
class  CloudIndexing
 Provides an API allowing to manipulate an index. More...
 
class  Common
 Common SDK methods also usable by clients.
 
class  ConfiguredProduct
 Information about a configured product on the BO. More...
 
class  CotcCoroutinesManager
 
class  CotcException
 Standard type of exceptions as forwarded most of the time in case of API error (network included). More...
 
class  CotcGameObject
 Place this object on all scenes where you would like to use CotC functionality, as described in this tutorial. More...
 
class  DomainEventLoop
 This class is responsible for polling the server waiting for new events. You should instantiate one and manage its lifecycle as the state of the application changes. More...
 
class  Done
 Generic result for an API call that has been successful and simply gives an indication of whether it was done properly or not. Usually the result should be true, but some operations may succeed and give an indication that nothing was done. You may use it as a boolean or get additional information by using it as a PropertiesObject. More...
 
class  DrawnItemsResult
 Response resulting from a CotcSdk.Match.DrawFromShoe call. More...
 
class  EmptyBundle
 Never instantiate this class. Use Bundle.Empty instead. Pass that everywhere an explicit configuration is not wanted. More...
 
class  ErrorCodeStringifier
 
class  EventLoopArgs
 Arguments of the EventLoopArgs.ReceivedEvent event. You can use args.Message.ToJson() to obtain more information. More...
 
class  ExceptionEventArgs
 An event arguments class holding an exception. Used with unhandled exceptions. More...
 
class  FriendStatusChangeEvent
 Event triggered when someone adds this gamer as a friend or changes his friendship status. More...
 
class  Game
 Provides functionality related to the entire game. More...
 
class  GameBatches
 Allows to run batches authenticated as a game (that is, unauthenticated). More...
 
class  Gamer
 Important object from the SDK, allowing to perform many operations that depend on a currently logged in user. More...
 
class  GamerAccountMethods
 API functions acting on an user account (convert, etc.). More...
 
class  GamerAchievements
 
class  GamerBatches
 Allows to run batches authenticated as a user. More...
 
class  GamerCommunity
 API methods related to the friends and so on of one gamer. More...
 
class  GamerGodfather
 Godfather (code) related functions. You may also want to subscribe to events (see CotcSdk.GamerGodfather.OnGotGodchild). More...
 
class  GamerInfo
 Info about a player. Can be enriched with information, accessible using the index operator []. Typically contains a profile field, with displayname, email and lang. You can fetch this by doing string name = GamerInfo["profile"]["displayName"]; More...
 
class  GamerKvStore
 Represents a key/value system with ACL rights, also known as key/value store. This class is scoped by domain, meaning that you can call .Domain("yourdomain") and perform additional calls that are scoped. More...
 
class  GamerMatches
 Some methods accept a PushNotification parameter. This parameter can be used to forward a push notification to the users who are not active at the moment. More...
 
class  GamerOutline
 Outline information about a player. Can be enriched with information, accessible using the index operator []. Typically contains a profile field, with displayname, email and lang. You can fetch this by doing string name = GamerOutline["profile"]["displayname"]; More...
 
class  GamerProfile
 Might contain the following: { "displayName" : "xxx", "email" : "xxx', "lang" : "en" } Usage: string name = gamerProfile["displayName"];. More...
 
class  GamerProfileMethods
 Exposes methods allowing to fetch and modify the profile of the signed in gamer. More...
 
class  GamerProperties
 Allows to manipulate the gamer properties. More...
 
class  GamerScores
 Scoring and leaderboard related functions. More...
 
class  GamerStore
 (App) Store API. More...
 
class  GamerTransactions
 Class allowing to manipulate the transactions and perform tasks related to achievements. This class is scoped by domain, meaning that you can call .Domain("yourdomain") and perform additional calls that are scoped. More...
 
class  GamerVfs
 Represents a key/value system, also known as virtual file system. This class is scoped by domain, meaning that you can call .Domain("yourdomain") and perform additional calls that are scoped. More...
 
class  GameVfs
 Represents a key/value system, also known as virtual file system, to be used for game properties. This class is scoped by domain, meaning that you can call .Domain("yourdomain") and perform additional calls that are scoped. More...
 
class  GotGodchildEvent
 Event triggered when a godfather code is used. This event is received by the one who originated the code (godfather). See CotcSdk.GamerGodfather.GenerateCode. More...
 
class  HttpClient
 
class  HttpRequest
 
class  HttpRequestFailedEventArgs
 This class is passed to the HttpRequestFailed handler as set on the Cloud. You need to do something with it, either call Abort or RetryIn else the http service will throw an exception. More...
 
class  HttpResponse
 
class  HttpTimeoutException
 
interface  ILogger
 
class  IndexResult
 Result of an index query. Represents a single returned object. This object is a CotcSdk.PropertiesObject, meaning that additional properties can be queried. If you want to check what is returned as a JSON object, simply log this.ToString(). More...
 
class  IndexSearchResult
 Contains the results of a search on the index. More...
 
interface  ISystemFunctions
 
class  LogEventArgs
 Information about a log entry. More...
 
class  LoginNetworkExtensions
 You can call LoginNetwork.Describe() to stringify the login network and pass it to various APIs.
 
class  Managers
 
class  Match
 Represents a match with which you can interact through high level functionality. A match object is returned when you create a match, join it and so on. You should subscribe to ReceivedEvent right after you got this object. More...
 
class  MatchEvent
 Basis for a match event. An event is actually always one of the subclasses (Match*Event). More...
 
class  MatchFinishEvent
 Event of type match.finish. Broadcasted to all participants except the one who initiated the request when a match is finished. More...
 
class  MatchInfo
 Represents a basic match with less information associated than a real match. This is the kind of matches that you may find in sub-objects returned by some calls (list, etc.). More...
 
class  MatchInviteEvent
 Event of type match.invite. Received by another player when someone invites him to the match. More...
 
class  MatchJoinEvent
 Event of type match.join. Broadcasted when a player joins a match. The joining player himself doesn't receive the event. More...
 
class  MatchLeaveEvent
 Event of type match.leave. Broadcasted when a player leaves the match. The leaving player himself doesn't receive the event. More...
 
class  MatchListResult
 Entry within a list of matches. More...
 
class  MatchMove
 Represents a move in a match. More...
 
class  MatchMoveEvent
 Event of type match.move. Broadcasted when a player makes a move. The player himself doesn't receive the event. More...
 
class  MatchShoeDrawnEvent
 Event of type match.shoedraw. Broadcasted when a player draws items from the shoe. The player himself does not receive the event. More...
 
class  MonoHttpClient
 
class  NonpagedList
 Represents a non-paginated list. Counterpart to CotcSdk.PagedList, replacing simple List before. These lists allow to retrieve additional information that you can enrich using batches on the server. More...
 
class  PagedList
 Represents a paginated list, which allows for easy navigation through multiple results. More...
 
class  PostedGameScore
 Result of posting a score. More...
 
class  Promise
 Promise of future result, which may fail or succeed. Returned as a result of any asnychronous operation. More...
 
class  PromiseExtensions
 Promise class extensions.
 
class  PromiseHandler
 Holds two callback delegates to call in case of resolved (success) or rejected (failure) Promise. Should only be used for internal SDK conveniency. More...
 
class  PropertiesObject
 Defines an object that can be queried for additional properties using indexers. The structure of the object remains read only though. More...
 
class  PurchaseTransaction
 Information about a purchased product transaction. More...
 
class  PushNotification
 Push notifications can be specified in some API calls to push an OS push notification to inactive users. It is typically a JSON with made of attributes which represent language -> message pairs. Here is an example: new PushNotification().Message("en", "Help me!").Message("fr", "Aidez moi!"). More...
 
class  Score
 Represents a score fetched from a leaderboard. More...
 
class  SocialNetworkFriend
 Data about a friend on the social network. The most important field is the id, which allows to recognize the gamer uniquely among the given social network. More...
 
class  SocialNetworkFriendResponse
 Wraps information about a list of friends coming from a social network. More...
 
class  Transaction
 Transaction as archived on the CotC servers. More...
 
class  TransactionResult
 Result of a transaction call. Contains the new balance (after the transaction has been executed atomically) and the list of triggered achievements. More...
 
class  UnityHttpClientV2
 
class  UnityLogger
 
class  UnitySystemFunctions
 
class  UrlBuilder
 
class  UserInfo
 Info about a user. Can be enriched with information, accessible using the index operator []. Typically contains a profile field, with displayname, email and lang. You can fetch this by doing string name = UserInfo["profile"]["displayname"]; More...
 
class  ValidateReceiptResult
 Result of CotcSdk.GamerStore.ValidateReceipt. More...
 

Enumerations

enum  ErrorCode {
  ErrorCode.Ok = 0, NetworkError = 2000, ServerError = 2001, NotImplemented = 2002,
  LogicError = 2003, InternalError = 2004, Canceled = 2005, AlreadyInProgress = 2006,
  NotSetup = 2100, BadAppCredentials = 2101, NotLoggedIn = 2102, BadParameters = 2104,
  EventListenerAlreadyRegistered = 2105, AlreadySetup = 2106, SocialNetworkError = 2107, LoginCanceled = 2108,
  ErrorWithExternalStore = 2109, ErrorCode.LastError
}
 Represents an error code as returned by a CotcException. More...
 
enum  FriendRelationshipStatus { Add, Blacklist, Forget }
 Status of friend relationship. More...
 
enum  ScoreOrder { HighToLow, LowToHigh }
 Describes the possible sorting orders for the score leaderboard. More...
 
enum  MatchStatus { Running, Finished }
 Status of a match. More...
 
enum  AchievementType { Limit }
 Type of achievement. The rules and the "Config" member of an AchievementDefinition depends on this. More...
 
enum  LoginNetwork {
  Anonymous, Email, Facebook, GooglePlus,
  GameCenter
}
 Social network used for identification / signing in. More...
 
enum  StoreType { Appstore, Macstore, Googleplay }
 Type of store in which products are purchased. More...
 
enum  PromiseState { Pending, Fulfilled, Rejected }
 Current state of the Promise. Should only be used for internal purposes. More...
 
enum  LogLevel { Verbose, Info, Warning, Error }
 Possible logging levels to be set. More...
 

Functions

delegate void EventLoopHandler (DomainEventLoop sender, EventLoopArgs e)
 Delegate called when receiving a message on a CotcSdk.DomainEventLoop. More...
 
delegate void HttpRequestFailedHandler (HttpRequestFailedEventArgs e)
 Delegate for failed HTTP requests. See Cloud.HttpRequestFailedHandler. More...
 

Enumeration Type Documentation

◆ FriendRelationshipStatus

Status of friend relationship.

◆ LogLevel

enum CotcSdk.LogLevel
strong

Possible logging levels to be set.

◆ PromiseState

enum CotcSdk.PromiseState
strong

Current state of the Promise. Should only be used for internal purposes.

◆ ScoreOrder

enum CotcSdk.ScoreOrder
strong

Describes the possible sorting orders for the score leaderboard.