|
Essential Kit
|
Namespace for essential kit features. You need to import this namespace along with VoxelBusters.CoreLibrary to use essential kit features.
Classes | |
| class | AchievementDefinition |
| Represents an object containing additional information related to game achievement. More... | |
| class | AddressBook |
| The AddressBook class provides cross-platform interface to access the contact information. More... | |
| class | AddressBookReadContactsResult |
| This class contains the information retrieved when AddressBook.ReadContacts(EventCallback<AddressBookReadContactsResult>) operation is completed. More... | |
| class | AddressBookRequestContactsAccessResult |
| This class contains the information retrieved when AddressBook.RequestContactsAccess(bool, EventCallback<AddressBookRequestContactsAccessResult>) operation is completed. More... | |
| class | AddressBookUnitySettings |
| The AddressBookUnitySettings class is used to configure Address Book module of Essential Kit. More... | |
| class | AlertDialog |
| The AlertDialog class provides an interface to display an alert message to the user. More... | |
| class | AlertDialogBuilder |
| Builder class for AlertDialog objects. Provides a convenient way to set the various fields of a AlertDialog. More... | |
| class | AppShortcutItem |
| Represents an app shortcut item. More... | |
| class | AppShortcuts |
| The AppShortcuts feature allowes to create shortcuts for the application. More... | |
| class | AppUpdater |
| The AppUpdater class provides cross-platform interface to facilitate updating the current version of the application. More... | |
| class | AppUpdaterUpdateInfo |
| The AppUpdaterUpdateInfo class provides information related to the status of the update. More... | |
| class | BillingPeriod |
| Represents duration of billing product subscription period. More... | |
| class | BillingPrice |
| Represents a billing price with its value, code, symbol, and display text. More... | |
| class | BillingProductDefinition |
| Represents an object containing information related to billing product definition. This contains the data you set in settings. More... | |
| class | BillingProductOffer |
| Represents a product offer for a billing product. More... | |
| class | BillingProductOfferPricingPhase |
| Represents a phase of pricing for a billing product offer. More... | |
| class | BillingProductOfferRedeemDetails |
| Represents details of a product offer to be redeemed. More... | |
| class | BillingProductPayoutDefinition |
| Represents payout information associated with the product. More... | |
| class | BillingProductRevocationInfo |
| Represents information about the revocation of a billing product. More... | |
| class | BillingProductSubscriptionInfo |
| Represents the information about the billing product subscription. More... | |
| class | BillingProductSubscriptionRenewalInfo |
| Represents the information about the billing product subscription renewal. More... | |
| class | BillingProductSubscriptionStatus |
| Represents the subscription status of a billing product. More... | |
| class | BillingServices |
| Provides cross-platform interface to request payment from a user for additional functionality or content that your application delivers. More... | |
| class | BillingServicesInitializeStoreResult |
| This class contains the information retrieved when BillingServices.InitializeStore operation is completed. More... | |
| class | BillingServicesRestorePurchasesResult |
| This class contains the information retrieved when BillingServices.OnRestorePurchasesComplete event is triggered. More... | |
| class | BillingServicesTransactionStateChangeResult |
| This class contains the information retrieved when BillingServices.OnTransactionStateChange event is triggered. More... | |
| class | BillingServicesUnitySettings |
| The BillingServicesUnitySettings class is used to configure the Billing module of Essential Kit. More... | |
| class | BuyProductOptions |
| Represents options for purchasing a IBillingProduct. More... | |
| class | CalendarNotificationTrigger |
| A trigger condition that causes a notification to be delivered at a specific date and time. More... | |
| class | CloudServices |
| Provides a cross-platform interface to sync information across various devices by storing it in the cloud. More... | |
| class | CloudServicesSavedDataChangeResult |
| This class contains the information related to CloudServices.OnSavedDataChange event. More... | |
| class | CloudServicesSynchronizeResult |
| This class contains the information related to CloudServices.OnSynchronizeComplete event. More... | |
| class | CloudServicesUserChangeResult |
| This class contains the information related to CloudServices.OnUserChange event. More... | |
| class | CloudServicesUtility |
| Utility class for handling cloud services related operations. More... | |
| class | DatePicker |
| Provides a cross-platform interface to access device's date picker view. More... | |
| class | DatePickerResult |
| This class contains the information retrieved when DatePicker.OnCloseCallback is invoked. More... | |
| class | DeepLinkDefinition |
| Represents definition of deep link which can be used to configure deep link services. More... | |
| class | DeepLinkServices |
| Provides cross-platform interface to handle deep links. More... | |
| class | DeepLinkServicesDynamicLinkOpenResult |
| This class contains the information retrieved when deep link is opened. More... | |
| class | GameServices |
| Provides cross-platform interface to easily integrate popular social gaming functionalities such as achievements, leaderboards on your mobile games. More... | |
| class | GameServicesAuthStatusChangeResult |
| This class contains the information retrieved when GameServices.Authenticate operation is completed. More... | |
| class | GameServicesLoadAchievementDescriptionsResult |
| This class contains the information retrieved when GameServices.LoadAchievements(EventCallback<GameServicesLoadAchievementsResult>) operation is completed. More... | |
| class | GameServicesLoadAchievementsResult |
| This class contains the information retrieved when GameServices.LoadAchievements(EventCallback<GameServicesLoadAchievementsResult>) operation is completed. More... | |
| class | GameServicesLoadLeaderboardsResult |
| This class contains the information retrieved when GameServices.LoadLeaderboards(EventCallback<GameServicesLoadLeaderboardsResult>) operation is completed. More... | |
| class | GameServicesLoadPlayerFriendsResult |
| This class contains the information retrieved when load player friends operation is completed. More... | |
| class | GameServicesLoadPlayersResult |
| This class contains the information retrieved when GameServices.LoadPlayers(string[], EventCallback<GameServicesLoadPlayersResult>) operation is completed. More... | |
| class | GameServicesLoadServerCredentialsResult |
| This class contains the information retrieved when GameServices.LoadServerCredentials(EventCallback<GameServicesLoadServerCredentialsResult>) operation is completed. More... | |
| class | GameServicesUnitySettings |
| The GameServicesUnitySettings class is used to configure Game Services module of Essential Kit. More... | |
| class | GameServicesViewResult |
| This class contains the information retrieved when game view is closed. More... | |
| interface | IAchievement |
| Provides an interface to communicate with game server about local players progress towards completing achievement. More... | |
| interface | IAchievementDescription |
| Provides an interface to access an achievement's properties such as achievement's title, max points, image etc. More... | |
| interface | IAddressBookContact |
| Provides a cross-platform interface to access contact properties, such as contact’s name, image, phone numbers etc. More... | |
| interface | IBillingProduct |
| Provides a cross-platform interface to access information about a product registered in Store. More... | |
| interface | IBillingTransaction |
| Provides an interface to access transaction information of the purchased product. More... | |
| interface | ICloudUser |
| Provides a cross-platform interface to access information related to active cloud user. More... | |
| interface | ILeaderboard |
| Provides interface to read data from a leaderboard stored on game server. More... | |
| interface | ILeaderboardScore |
| Provides a cross-platform interface to access information about a leaderboard score. More... | |
| interface | ILocalPlayer |
| Provides interface to access information about the authenticated player running your game on the device. More... | |
| interface | IMediaContent |
| Interface to be implemented by media content classes. More... | |
| interface | INotification |
| Provides a cross-platform interface to access properties of Notification object. More... | |
| interface | INotificationTrigger |
| Base interface for representing an event that triggers the delivery of a notification. More... | |
| interface | IPlayer |
| Provides a cross-platform interface to access information about a player playing your game. More... | |
| interface | IScore |
| class | LeaderboardDefinition |
| Represents an object containing additional information related to game leaderboard. More... | |
| class | LeaderboardLoadScoresResult |
| This class contains the information retrieved when load scores operation is completed. More... | |
| class | MailComposer |
| The MailComposer class provides an interface to compose and send an email message. More... | |
| class | MailComposerExtensions |
| Mail composer extensions. More... | |
| class | MailComposerResult |
| This class contains the result of the user action which caused MailComposer interface to dismiss. More... | |
| class | MediaContentCaptureOptions |
| Contains options which customize the behavior of the MediaServices.CaptureMediaContent method. More... | |
| class | MediaContentSaveOptions |
| Contains options which customize the behavior of the MediaServices.SaveMediaContent method. More... | |
| class | MediaContentSelectOptions |
| Contains options for selecting media content. More... | |
| class | MediaServices |
| Provides cross-platform interface to access devices's media gallery and camera for picking/saving media content. More... | |
| class | MediaServicesRequestCameraAccessResult |
| This class contains the information retrieved when MediaServices.RequestCameraAccess(bool, EventCallback<MediaServicesRequestCameraAccessResult>) operation is completed. More... | |
| class | MediaServicesRequestGalleryAccessResult |
| This class contains the information retrieved when MediaServices.RequestGalleryAccess(GalleryAccessMode, bool, EventCallback<MediaServicesRequestGalleryAccessResult>) operation is completed. More... | |
| class | MediaServicesSaveImageToGalleryResult |
| This class contains the information retrieved when MediaServices.SaveImageToGallery(Texture2D, EventCallback<MediaServicesSaveImageToGalleryResult>) operation is completed. More... | |
| class | MediaServicesSelectMediaContentResult |
| Contains information about the media content selected by the user. More... | |
| class | MessageComposer |
| The MessageComposer class provides a standard interface for composing and sending SMS or MMS messages. More... | |
| class | MessageComposerResult |
| This class contains the result of the user action which caused MessageComposer interface to dismiss. More... | |
| class | NetworkServices |
| Provides cross-platform interface to check network connectivity status. More... | |
| class | NetworkServicesHostReachabilityStatusChangeResult |
| This object contains the information retrieved when NetworkServices.OnHostReachabilityChange event occurs. More... | |
| class | NetworkServicesInternetConnectivityStatusChangeResult |
| This interface contains the information retrieved when NetworkServices.OnInternetConnectivityChange event occurs. More... | |
| class | NotificationAndroidProperties |
| Notification properties specific to Android platform. More... | |
| class | NotificationBuilder |
| Builder class for INotification objects. Provides a convenient way to set the various fields of a INotification. More... | |
| class | NotificationChannel |
| Class representing a notification channel. More... | |
| class | NotificationIosProperties |
| Notification properties specific to iOS platform. More... | |
| class | NotificationServices |
| Provides cross-platform interface for scheduling, registering and handling notifications. More... | |
| class | NotificationServicesGetDeliveredNotificationsResult |
| This class contains the information retrieved when NotificationServices.GetDeliveredNotifications(EventCallback<NotificationServicesGetDeliveredNotificationsResult>) request is completed. More... | |
| class | NotificationServicesGetScheduledNotificationsResult |
| This class contains the information retrieved when NotificationServices.GetScheduledNotifications(EventCallback<NotificationServicesGetScheduledNotificationsResult>) request is completed. More... | |
| class | NotificationServicesGetSettingsResult |
| This class contains the information retrieved when NotificationServices.GetSettings(Callback<NotificationServicesGetSettingsResult>) is completed. More... | |
| class | NotificationServicesNotificationReceivedResult |
| This class contains the information retrieved when notification message is received. More... | |
| class | NotificationServicesRegisterForPushNotificationsResult |
| This class contains the information retrieved when NotificationServices.RegisterForPushNotifications(EventCallback<NotificationServicesRegisterForPushNotificationsResult>) operation is completed. More... | |
| class | NotificationServicesRequestPermissionResult |
| This class contains the information retrieved when NotificationServices.RequestPermission(NotificationPermissionOptions, bool, EventCallback<NotificationServicesRequestPermissionResult>) operation is completed. More... | |
| class | NotificationSettings |
| Represents the user’s notification settings. More... | |
| class | PromptUpdateOptions |
| Represents the options for prompting an update to the user. Use the PromptUpdateOptions.Builder to create an instance of this class. More... | |
| class | PushNotificationTrigger |
| A trigger condition that indicates the notification was using a Push Notification Service. More... | |
| class | RateMyApp |
| The RateMyApp class provides an unique way to prompt user to review the app. More... | |
| class | RateMyAppLocalisationKey |
| Keys used to localize the rate my app feature. More... | |
| class | RawMediaData |
| Contains information about raw media data. More... | |
| class | ReadContactsOptions |
| Represents a set of options that can be used to read contacts from the user's device. More... | |
| class | ServerCredentials |
| Contains information about the game service credentials which can be used to connect to game service from your backend. More... | |
| class | ShareItem |
| Class internally used to pass data options into sharing functions. More... | |
| class | ShareSheet |
| The ShareSheet class provides an interface to access standard services from your app. More... | |
| class | ShareSheetResult |
| This class contains the result of the user action which caused ShareSheet interface to dismiss. More... | |
| class | SharingServices |
| Provides a cross-platform interface to access sharing services. More... | |
| class | SocialShareComposer |
| The SocialShareComposer class provides an interface to compose a post for supported social networking services. More... | |
| class | SocialShareComposerResult |
| This class contains the result of the user action which caused SocialShareComposer interface to dismiss. More... | |
| class | TaskServices |
| The TaskServices class provides cross-platform interface to schedule or continue tasks in background. This can be used for running tasks uninterruptedly. More... | |
| class | TimeIntervalNotificationTrigger |
| A trigger condition that causes a notification to be delivered after the specified amount of time elapses. More... | |
| class | Utilities |
| Provides a cross-platform interface to access commonly used native features. More... | |
| class | WebView |
| Provides a cross-platform interface to display web contents inside your application. More... | |
| class | WebViewExtensions |
| Web view extensions. More... | |
| class | WebViewRunJavaScriptResult |
| This class contains the information retrieved when WebView.RunJavaScript(string, EventCallback<WebViewRunJavaScriptResult>) operation is completed. More... | |
Enumerations | |
| enum | AddressBookContactsAccessStatus { NotDetermined , Restricted , Denied , Authorized , Limited } |
| An access status the user can grant for an app to access the contacts information. More... | |
| enum | AddressBookErrorCode : int { Unknown , PermissionDenied } |
| Contains the list of errors codes that can occur during address book operations. More... | |
| enum | ReadContactsConstraint { None = 0 , MustIncludeName = 1 << 0 , MustIncludePhoneNumber = 1 << 1 , MustIncludeEmail = 1 << 2 } |
| Represents constraints for reading contacts. note: You can set multiple constraints at once. More... | |
| enum | AppShortcutsErrorCode { Unknown } |
| The error codes for App Shortcuts feature. More... | |
| enum | AppUpdaterErrorCode { Unknown , NetworkIssue , UpdateNotCompatible , UpdateInfoNotAvailable , UpdateNotAvailable , UpdateInProgress , UpdateCancelled } |
| The error codes for AppUpdater. More... | |
| enum | AppUpdaterUpdateStatus { Unknown = 0 , Available = 1 , NotAvailable = 2 , InProgress = 3 , Downloaded = 4 } |
| The status of the application update. More... | |
| enum | BillingEnvironment { Unknown , Production , Sandbox , Local } |
| Server environment where current billing transactions are processed and signed. More... | |
| enum | BillingPeriodUnit : int { Day , Week , Month , Year } |
| Unit for billing product subscription period. More... | |
| enum | BillingProductOfferCategory : int { Unknown , Introductory , Promotional , Code } |
| Represents a category of a billing product offer. More... | |
| enum | BillingProductPayoutCategory { Currency = 1 , Item , Other = 1000 } |
| Defines the categories for billing product payouts. More... | |
| enum | BillingProductRevocationReason { None , Unknown , DeveloperIssue } |
| Reason for which the product got revoked. More... | |
| enum | BillingProductSubscriptionExpirationReason : int { None , Unknown , AutoRenewDisabled , BillingError , DidNotConsentToPriceIncrease , ProductUnavailable } |
| Reason for billing product subscription expiration. More... | |
| enum | BillingProductSubscriptionPriceIncreaseStatus : int { Unknown , NoIncreasePending , Agreed , Pending } |
| Status of billing product subscription price increase action. More... | |
| enum | BillingProductSubscriptionRenewalState { Unknown , Subscribed , Expired , InBillingRetryPeriod , InGracePeriod , Revoked } |
| State of the subscription renewal. More... | |
| enum | BillingProductType { Consumable , NonConsumable , Subscription } |
| An enumeration for the available billing product types. More... | |
| enum | BillingReceiptVerificationState { NotDetermined , Success , Failed } |
| The state of a payment receipt verification. More... | |
| enum | BillingServicesErrorCode : int { Unknown , NetworkError , SystemError , BillingNotAvailable , StoreNotInitialized , StoreIsBusy , UserCancelled , OfferNotApplicable , OfferNotValid , QuantityNotValid , ProductNotAvailable , ProductOwned , FeatureNotAvailable } |
| Describes the error code which can occur when requesting for payment. More... | |
| enum | BillingProductOfferPaymentMode : int { Unknown , FreeTrial , PayAsYouGo , PayUpFront } |
| Payment mode of Billing Product Subscription. More... | |
| enum | BillingTransactionState { } |
| The state of a billing product payment. More... | |
| enum | CloudSavedDataChangeReasonCode { ServerChange , InitialSyncChange , QuotaViolationChange , AccountChange } |
| Possible reasons when cloud data changed event occurs. More... | |
| enum | CloudServicesErrorCode { Unknown } |
| Contains the list of error codes that can occur during cloud services operations. More... | |
| enum | CloudUserAccountStatus { CouldNotDetermine = 0 , Available = 1 , Restricted = 2 , NoAccount = 3 } |
| Enumeration indicating the availability of the user’s cloud account. More... | |
| enum | GameServicesErrorCode { Unknown , SystemError , NetworkError , NotAllowed , DataNotAvailable , NotSupported , ConfigurationError , InvalidInput , NotAuthenticated } |
| Enum used to specify the error code for game services operations. More... | |
| enum | GameServicesViewResultCode { Unknown , Done } |
| Result codes returned when the game service interface is dismissed. More... | |
| enum | LeaderboardPlayerScope { Global , FriendsOnly } |
| The scope of player to be searched for scores. More... | |
| enum | LeaderboardTimeScope { Today , Week , AllTime } |
| The period of time to which user's best score are restricted. More... | |
| enum | LocalPlayerAuthStatus { NotAvailable = 0 , Authenticating , Authenticated } |
| Enumeration for determining ILocalPlayer auth status. More... | |
| enum | ServerCredentialAdditionalScope |
| Specifies the additional scope of the game service credentials. | |
| enum | CameraAccessStatus { NotDetermined , Restricted , Denied , Authorized } |
| An access status the user can grant for an app to access the camera. More... | |
| enum | GalleryAccessMode { Read = 1 << 0 , ReadWrite = 1 << 1 } |
| Enumeration values indicating the mode in which application wants to access user's gallery. More... | |
| enum | GalleryAccessStatus { NotDetermined , Restricted , Denied , Authorized } |
| An access status the user can grant for an app to access the gallery data. More... | |
| enum | MediaContentCaptureSource { Camera } |
| Represents a source of media content capture. More... | |
| enum | MediaContentCaptureType { Image , Video } |
| Type of media content that can be captured. More... | |
| enum | MediaServicesErrorCode { Unknown , PermissionNotAvailable , UserCancelled , DataNotAvailable } |
| Contains a list of error codes that can occur while using the Media Services. More... | |
| enum | AlertDialogStyle { Default , ActionSheet } |
| An enumeration for the available alert dialog styles. More... | |
| enum | DatePickerMode { Date , Time , DateAndTime } |
| Specifies the mode of the date picker to be displayed. More... | |
| enum | NotificationAlertStyle { None = 0 , Alert , Banner } |
| Constants indicating the presentation styles for alerts. More... | |
| enum | NotificationPermissionOptions { } |
| Enumeration values for requesting authorization to interact with the user. More... | |
| enum | NotificationPermissionStatus { NotDetermined , Denied , Authorized , Provisional } |
| Constants indicating whether the app is allowed to schedule notifications. More... | |
| enum | NotificationPresentationOptions { Alert = 1 << 0 , Badge = 1 << 1 , Sound = 1 << 2 } |
| Constants indicating how to present a notification in a foreground app. More... | |
| enum | NotificationPreviewStyle { Always = 0 , WhenAuthenticated , Never , NotAccessible } |
| Constants indicating the style previewing a notification's content. More... | |
| enum | NotificationPriority { Low = 0 , Medium = 1 , High = 2 , Max = 3 } |
| Specifies the priority levels for notifications, determining how they are delivered to the user. More... | |
| enum | NotificationServicesErrorCode { Unknown , PermissionNotAvailable , TriggerNotValid , ConfigurationError , ScheduledTimeNotValid } |
| Represents error codes for notification services. More... | |
| enum | NotificationSettingStatus { Disabled , Enabled , NotSupported , NotAccessible } |
| Enumeration values indicating the current status of a notification setting. More... | |
| enum | NotificationTriggerType { } |
| Constants indicating available trigger types. More... | |
| enum | PushNotificationServiceType { None = 0 , Custom } |
| Defines the type of push notification service which sends the notifications to the device. More... | |
| enum | RateMyAppConfirmationPromptActionType { RemindLater , Cancel , Ok } |
| Enum representing the actions that can be taken when the rate my app confirmation prompt is shown. More... | |
| enum | MailComposerResultCode { Unknown , Cancelled , Saved , Sent , Failed } |
| Result codes returned when the MailComposer interface is dismissed. More... | |
| enum | MessageComposerResultCode { Unknown , Cancelled , Sent , Failed } |
| Result codes returned when the MessageComposer interface is dismissed. More... | |
| enum | ShareSheetResultCode { Unknown , Cancelled , Done } |
| Result codes returned when the ShareSheet interface is dismissed. More... | |
| enum | SharingServicesErrorCode { Unknown , AttachmentNotValid } |
| Error codes for Sharing Services. More... | |
| enum | SocialShareComposerResultCode { Unknown , Cancelled , Done } |
| Possible values for the result, when SocialShareComposer interface is dismissed. More... | |
| enum | SocialShareComposerType { Facebook , Twitter , WhatsApp } |
| The enum specifies the sharing service you want to post to. More... | |
| enum | TaskServicesErrorCode { Unknown } |
| The error codes for Task Services. More... | |
| enum | WebViewStyle { Default , Popup , Browser } |
| Enumeration for supported webview control styles. More... | |
| enum AddressBookErrorCode : int |
| enum AppUpdaterErrorCode |
| enum BillingEnvironment |
| enum BillingPeriodUnit : int |
| enum BillingProductOfferCategory : int |
| enum BillingProductSubscriptionExpirationReason : int |
| enum BillingProductType |
| enum BillingServicesErrorCode : int |
| enum BillingProductOfferPaymentMode : int |
| enum LeaderboardTimeScope |
| enum CameraAccessStatus |
| enum GalleryAccessMode |
| enum GalleryAccessStatus |
| enum AlertDialogStyle |
| enum DatePickerMode |
| enum NotificationPriority |
| enum WebViewStyle |