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	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	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...

Enumeration Type Documentation

◆ AddressBookContactsAccessStatus

enum AddressBookContactsAccessStatus

Enumerator
NotDetermined	The user has not yet made a choice regarding whether this app can access the address book data.
Restricted	The application is not authorized to access the address book data.
Denied	The user explicitly denied access to address book data for this application.
Authorized	The application is authorized to access address book data.
Limited	The application is authorized to access limited address book data.

◆ AddressBookErrorCode

enum AddressBookErrorCode : int

Enumerator
Unknown	Unknown error occurred.
PermissionDenied	Permission to access the address book was denied.

◆ ReadContactsConstraint

enum ReadContactsConstraint

By default, the module will return all the contacts.

Enumerator
None	0	No constraints.
MustIncludeName	1 << 0	Must include name of the contact.
MustIncludePhoneNumber	1 << 1	Must include phone number of the contact.
MustIncludeEmail	1 << 2	Must include email of the contact.

◆ AppShortcutsErrorCode

enum AppShortcutsErrorCode

Enumerator
Unknown	The error code is unknown.

◆ AppUpdaterErrorCode

enum AppUpdaterErrorCode

Enumerator
Unknown	The error code is unknown.
NetworkIssue	There is a network issue.
UpdateNotCompatible	The update is not compatible with the current version.
UpdateInfoNotAvailable	There is no update info fetched for the current version.
UpdateNotAvailable	The update is not available.
UpdateInProgress	The update is already in progress.
UpdateCancelled	The update has been cancelled.

◆ AppUpdaterUpdateStatus

enum AppUpdaterUpdateStatus

Enumerator
Unknown	0	The application update status is unknown.
Available	1	The application is not up to date and needs to be updated.
NotAvailable	2	The application is up to date.
InProgress	3	The application is currently being updated.

◆ BillingEnvironment

enum BillingEnvironment

Enumerator
Unknown	The environment is not known.
Production	The production environment where real transactions occur.
Sandbox	The sandbox environment used for testing purposes.
Local	The local environment for development purposes.

◆ BillingPeriodUnit

enum BillingPeriodUnit : int

Enumerator
Day	Day unit for billing product subscription period.
Week	Week unit for billing product subscription period.
Month	Month unit for billing product subscription period.
Year	Year unit for billing product subscription period.

◆ BillingProductOfferCategory

enum BillingProductOfferCategory : int

Enumerator
Unknown	Unknown offer category.
Introductory	Offer category for introductory offers.
Promotional	Offer category for promotional offers.
Code	Offer category for code-based offers.

◆ BillingProductPayoutCategory

enum BillingProductPayoutCategory

Enumerator
Currency	1	Represents the category of currency payout.
Item		Represents the category of item payout.
Other	1000	Represents all other categories of payout.

◆ BillingProductRevocationReason

enum BillingProductRevocationReason

Enumerator
None	No revocation.
Unknown	Unknown reason.
DeveloperIssue	The revocation was caused by a developer related issue.

◆ BillingProductSubscriptionExpirationReason

enum BillingProductSubscriptionExpirationReason : int

Enumerator
None	No expiration reason available.
Unknown	Unknown expiration reason.
AutoRenewDisabled	Auto-Renew disabled.
BillingError	Expiration due to billing error.
DidNotConsentToPriceIncrease	Expiration due to user did not consent to price increase.
ProductUnavailable	Expiration due to product being unavailable.

◆ BillingProductSubscriptionPriceIncreaseStatus

enum BillingProductSubscriptionPriceIncreaseStatus : int

Enumerator
Unknown	Unknown status of billing product subscription price increase action.
NoIncreasePending	No price increase is pending.
Agreed	User agreed to the price increase.
Pending	Price increase is pending.

◆ BillingProductSubscriptionRenewalState

enum BillingProductSubscriptionRenewalState

Enumerator
Unknown	Unknown state of the subscription renewal.
Subscribed	User is currently subscribed to the product.
Expired	User's subscription to the product has expired.
InBillingRetryPeriod	The App Store is attempting to renew a subscription on behalf of the user.
InGracePeriod	User's subscription is in the process of being canceled and will terminate at the end of the current billing cycle.
Revoked	User explicitly revoked the subscription.

◆ BillingProductType

enum BillingProductType

Enumerator
Consumable	The consumable product.
NonConsumable	The non consumable product.
Subscription	The subscription product.

◆ BillingReceiptVerificationState

enum BillingReceiptVerificationState

Enumerator
NotDetermined	Receipt verification has not yet been done.
Success	Receipt was successfully verified.
Failed	Receipt verification failed for some reason. Possible reasons can be network issue, mismatch of app build details etc.

◆ BillingServicesErrorCode

enum BillingServicesErrorCode : int

Enumerator
Unknown	Unknown error occurred.
NetworkError	Network error occurred.
SystemError	System error occurred.
BillingNotAvailable	Billing service is not available.
StoreNotInitialized	Store is not initialized.
StoreIsBusy	Store is busy processing another request.
UserCancelled	User cancelled the payment.
OfferNotApplicable	Offer is not applicable.
OfferNotValid	Offer is not valid.
QuantityNotValid	Quantity is not valid.
ProductNotAvailable	Product is not available.
ProductOwned	Product is already owned.
FeatureNotAvailable	Feature is not available.

◆ BillingProductOfferPaymentMode

enum BillingProductOfferPaymentMode : int

Enumerator
Unknown	Unknown payment mode.
FreeTrial	Payment mode for a free trial.
PayAsYouGo	Payment mode for pay as you go subscriptions.
PayUpFront	Payment mode for pay up front subscriptions.

◆ BillingTransactionState

enum BillingTransactionState

Enumerator
Purchasing	Transaction is being added to the server queue.
Purchased	Transaction is in queue, user has been charged.
Failed	Transaction was cancelled or failed before being added to the server queue.
Restored	This transaction restores content previously purchased by the user.
Deferred	The transaction is in the queue, but its final status is pending external action.
Refunded	This transaction was refunded back to the user. You can restrict/remove associated item.

◆ CloudSavedDataChangeReasonCode

enum CloudSavedDataChangeReasonCode

Enumerator
ServerChange	This occurs when another instance of your app using same cloud service account, uploads a new value.
InitialSyncChange	This occurs when an attempt to write to key-value storage was discarded because an initial download from cloud server has not yet happened.
QuotaViolationChange	This occurs when your app’s key-value store has exceeded its space quota on the cloud server.
AccountChange	This occurs when user has changed the cloud service account. The keys and values in the local key-value store have been replaced with those from the new account.

◆ CloudServicesErrorCode

enum CloudServicesErrorCode

Enumerator
Unknown	Unknown error occurred.

◆ CloudUserAccountStatus

enum CloudUserAccountStatus

Enumerator
CouldNotDetermine	0	Indicates that an error occurred during an attempt to retrieve the account status.
Available	1	The user’s iCloud account is available and may be used by this app.
Restricted	2	The user’s iCloud account is not available. Access was denied due to Parental Controls.
NoAccount	3	The user’s iCloud account is not available because no account information has been provided for this device.

◆ GameServicesErrorCode

enum GameServicesErrorCode

Enumerator
Unknown	The error code indicating that the cause of the error could not be determined.
SystemError	The error code indicating that an error occurred on the server.
NetworkError	The error code indicating that a network error occurred.
NotAllowed	The error code indicating that the operation was not allowed.
DataNotAvailable	The error code indicating that the data being requested is not available.
NotSupported	The error code indicating that the feature is not supported or enabled.
ConfigurationError	The error code indicating that the configuration is invalid.
InvalidInput	The error code indicating that the input was invalid.
NotAuthenticated	The error code indicating that the user is not authenticated.

◆ GameServicesViewResultCode

enum GameServicesViewResultCode

Enumerator
Unknown	The user action could not be determined. This occurs in platforms where there is no provision to find result.
Done	The user successfully closed.

◆ LeaderboardPlayerScope

enum LeaderboardPlayerScope

Enumerator
Global	All the players are considered for search.
FriendsOnly	Only friends of local player are considered for search.

◆ LeaderboardTimeScope

enum LeaderboardTimeScope

Enumerator
Today	Best score of all user's recorded in past 24hrs is returned.
Week	Best score of all user's recorded in past week is returned.
AllTime	Best score of all user's recorded is returned.

◆ LocalPlayerAuthStatus

enum LocalPlayerAuthStatus

Enumerator
NotAvailable	0	User authentication status is not found.
Authenticating		Local player auth process has been initiated.
Authenticated		Local player is signed in.

◆ CameraAccessStatus

enum CameraAccessStatus

Enumerator
NotDetermined	The user has not yet made a choice regarding whether this app can access the camera.
Restricted	The application is not authorized to access the camera.
Denied	The user explicitly denied access to camera for this application.
Authorized	The application is authorized to access camera.

◆ GalleryAccessMode

enum GalleryAccessMode

Enumerator
Read	1 << 0	The ability to access gallery files.
ReadWrite	1 << 1	The ability to access and write files to gallery.

◆ GalleryAccessStatus

enum GalleryAccessStatus

Enumerator
NotDetermined	The user has not yet made a choice regarding whether this app can access the gallery data.
Restricted	The application is not authorized to access the gallery data.
Denied	The user explicitly denied access to gallery data for this application.
Authorized	The application is authorized to access gallery data.

◆ MediaContentCaptureSource

enum MediaContentCaptureSource

Enumerator
Camera	Capture media content from a camera.

◆ MediaContentCaptureType

enum MediaContentCaptureType

Enumerator
Image	Capture an image.
Video	Capture a video.

◆ MediaServicesErrorCode

enum MediaServicesErrorCode

Enumerator
Unknown	An unknown error occurred.
PermissionNotAvailable	The permission to access the camera or photo library is not available.
UserCancelled	The user cancelled the operation.
DataNotAvailable	The required data is not available.

◆ AlertDialogStyle

enum AlertDialogStyle

Enumerator
Default	An overlay alert dialog is displayed.
ActionSheet	An action sheet style is used to display alert. (iOS feature)

◆ DatePickerMode

enum DatePickerMode

Enumerator
Date	The date picker should show date only.
Time	The date picker should show time only.
DateAndTime	The date picker should show date and time.

◆ NotificationAlertStyle

enum NotificationAlertStyle

Enumerator
None	0	No alert.
Alert		Modal alerts.
Banner		Banner alerts.

◆ NotificationPermissionOptions

enum NotificationPermissionOptions

Enumerator
Badge	1 << 0	The ability to update the app’s badge.
Sound	1 << 1	The ability to play sounds.
Alert	1 << 2	The ability to display alerts.
CarPlay	1 << 3	The ability to display notifications in a CarPlay environment.
CriticalAlert	1 << 4	The ability to play sounds for critical alerts.
ProvidesAppNotificationSettings	1 << 5	An option indicating the system should display a button for in-app notification settings.
Provisional	1 << 6	The ability to post noninterrupting notifications provisionally to the Notification Center.
Announcement	1 << 7	The ability for Siri to automatically read out messages over AirPods.

◆ NotificationPermissionStatus

enum NotificationPermissionStatus

Enumerator
NotDetermined	The user hasn't yet made a choice about whether the app is allowed to schedule notifications.
Denied	The app isn't authorized to schedule or receive notifications.
Authorized	The app is authorized to schedule or receive notifications.
Provisional	The application is provisionally authorized to post noninterruptive user notifications.

◆ NotificationPresentationOptions

enum NotificationPresentationOptions

Enumerator
Alert	1 << 0	Display the alert using the content provided by the notification.
Badge	1 << 1	Apply the notification's badge value to the app’s icon.
Sound	1 << 2	Play the sound associated with the notification.

◆ NotificationPreviewStyle

enum NotificationPreviewStyle

Enumerator
Always	0	The notification's content is always shown, even when the device is locked.
WhenAuthenticated		The notification's content is shown only when the device is unlocked.
Never		The notification's content is never shown, even when the device is unlocked.

◆ NotificationPriority

enum NotificationPriority

Enumerator
Low	0	Low priority. Can be silent or with no disturbance.
Medium	1	Medium priority. (Default) Can make noise, alert in banner, but respects battery optimization settings or focus mode.
High	2	High priority. Can make noise, alert in banner and can be visually intruding ("May" break-through doze/battery optimization or focus modes).
Max	3	Max priority. Can make noise, alert in banner and visually intruding ("Must" break-through doze or focus modes).

◆ NotificationServicesErrorCode

enum NotificationServicesErrorCode

Enumerator
Unknown	An unknown error occurred.
PermissionNotAvailable	The permission for notifications is not available.
TriggerNotValid	The notification trigger is not valid.
ConfigurationError	There was a configuration error.
ScheduledTimeNotValid	The scheduled time for the notification is not valid.

◆ NotificationSettingStatus

enum NotificationSettingStatus

Enumerator
Disabled	The notification setting is turned off.
Enabled	The notification setting is turned on.
NotSupported	The app does not support this notification setting.
NotAccessible	The platform unable to fetch this setting.

◆ NotificationTriggerType

enum NotificationTriggerType

Enumerator
TimeInterval	1 << 0	Triggers notification after the specified amount of time elapses.
Calendar	1 << 1	Triggers notification at a specific date and time.
Location	1 << 2	Triggers notification after the user's device enters or exits the specified geographic region.
PushNotification	1 << 3	Notification received from Push Notification Service.

◆ PushNotificationServiceType

enum PushNotificationServiceType

Enumerator
None	0	Disables receiving remote push notifications completely as no service is used to send push notifications.
Custom		Custom push notification backend service which sends the payload to the device in plugin's expected format.

◆ RateMyAppConfirmationPromptActionType

enum RateMyAppConfirmationPromptActionType

Enumerator
RemindLater	The user has chosen to be reminded later.
Cancel	The user has chosen to cancel.
Ok	The user has chosen to rate the app.

◆ MailComposerResultCode

enum MailComposerResultCode

Enumerator
Unknown	The user action could not be determined.
Cancelled	The user cancelled the operation. No email message was queued.
Saved	The email message was saved in the user’s Drafts folder.
Sent	The email message was queued in the user’s outbox.
Failed	The email message was not saved or queued, possibly due to an error.

◆ MessageComposerResultCode

enum MessageComposerResultCode

Enumerator
Unknown	The user action could not be determined. This occurs in platforms where there is no provision to find result.
Cancelled	The user canceled the composition.
Sent	The user successfully queued or sent the message.
Failed	The message was not saved or queued, possibly due to an error.

◆ SharingServicesErrorCode

enum SharingServicesErrorCode

Enumerator
Unknown	Unknown error.
AttachmentNotValid	Attachment to be shared is not valid.

◆ SocialShareComposerResultCode

enum SocialShareComposerResultCode

Enumerator
Unknown	The composer view is dismissed, but system couldn't determine the result. This occurs in platforms where there is no provision to find result.
Cancelled	The view controller is dismissed without sending the post. For example, the user selects Cancel or the account is not available.
Done	The composer view is dismissed and the message is being sent in the background. This occurs when the user selects Done.

◆ SocialShareComposerType

enum SocialShareComposerType

Enumerator
Facebook	The value indicates Facebook platform.
Twitter	The value indicates Twitter platform.
WhatsApp	The value indicates WhatsApp platform.

◆ TaskServicesErrorCode

enum TaskServicesErrorCode

Enumerator
Unknown	The error code is unknown.

◆ WebViewStyle

enum WebViewStyle

Enumerator

Default

No controls are shown for web view. This appearence is ideal for banner ads like requirement.

Popup

This option creates a close button at top-right corner of the web view. On clicking this, web view gets dismissed.

Note: Incase if you want to permanetly remove web view instance, use WebView.Destory.

Browser

This option provides browser like appearence with 4 buttons for easy access to web view features.

It has Back and Forward buttons for navigating through the history. Reload button for reloading the current webpage contents. And finally, Done button for dismissing the web view.

Classes

Enumerations