Cross Platform Native Plugins
A true cross platform tool for Unity which provides unique and unified way to access native functionality on mobile platforms.
Classes | Enumerations
VoxelBusters.NativePlugins Namespace Reference

Classes

class  Achievement
 Represents an object used to communicate with game server about local user's progress towards completing achievement. More...
 
class  AchievementDescription
 Represents an object used to describe an achievement's properties such as achievement's title, max points, image etc. More...
 
class  AddressBook
 Provides cross-platform interface to access the user’s contact information. More...
 
class  AddressBookContact
 Represents an immutable object of contact properties, such as contact’s name, image, phone numbers etc. More...
 
class  Billing
 Provides cross-platform interface to request payment from a user for additional functionality or content that your application delivers. More...
 
class  BillingProduct
 Represents an object that holds information about a product registered in Store. More...
 
class  BillingTransaction
 Represents an object that holds transaction information of the purchased product. More...
 
class  CloudServices
 Provides a cross-platform interface to sync information across various devices by storing it in the cloud. More...
 
class  CrossPlatformNotification
 Is a wrapper class that encapsulates details about the notification. More...
 
class  FBShareComposer
 Provides an interface to compose a post and share it on Facebook. More...
 
class  GameServices
 Provides cross-platform interface to easily integrate popular social gaming functionalities such as achievements, leaderboards on your mobile games. More...
 
interface  IShareView
 Interface implemented by the share composer object. More...
 
class  Leaderboard
 Represents an object used to read data from a leaderboard stored on game server. More...
 
class  LocalUser
 Represents an object that holds information about the authenticated user running your game on the device. More...
 
class  MailShareComposer
 Provides an interface to compose and send email messages. More...
 
class  MediaLibrary
 Provides cross-platform interface to access devices's media gallery and camera for picking images and playing videos. More...
 
class  MessageShareComposer
 Provides an interface to compose and send text messages. More...
 
class  NetworkConnectivity
 Provides cross-platform interface to check network connectivity status. More...
 
class  NotificationService
 Provides cross-platform interface for scheduling, registering and handling notifications. More...
 
class  RateMyApp
 For getting user reviews, this class provides unique way to prompt user based on configured settings. More...
 
class  Score
 Represents an object that holds information for a score that was earned by the user. More...
 
class  ShareSheet
 Provides an interface to display native view with various share services that your users can choose to use from your application. More...
 
class  Sharing
 Provides cross-platform interface to various sharing services such as posting content to social media sites, sending items via email or SMS, and more. More...
 
class  SocialShareComposerBase
 Base class to compose a post and share it on social network. More...
 
class  SocialShareSheet
 Provides an interface to display native view with various social share services that your users can choose to use from your application. More...
 
class  Twitter
 Provides cross-platform interface to Twitter login and sending requests on the behalf of the user. Additionally, it includes methods to compose and send Tweet messages. More...
 
class  TwitterSession
 Represents an immutable object, that encapsulates the authorization details of an Twitter session. More...
 
class  TwitterShareComposer
 Provides an interface to compose a post and publish it on Twitter. More...
 
class  TwitterUser
 Represents an immutable object, that holds information about user on Twitter. More...
 
class  UI
 Provides a cross-platform interface for creating and presenting native user interfaces. More...
 
class  User
 Represents an object that holds information about a user playing your game. More...
 
class  Utility
 Provides a cross-platform interface to access useful features such as RateMyApp, app's bundle information etc. More...
 
class  WebView
 Provides a cross-platform interface to display web contents inside your application. More...
 
class  WebViewMessage
 Represents an immutable object, that holds information about a message sent from native webview. More...
 
class  WhatsAppShareComposer
 Provides an interface to share contents on WhatsApp. More...
 

Enumerations

enum  eABAuthorizationStatus { NOT_DETERMINED, RESTRICTED, DENIED, AUTHORIZED }
 Different possible values for the authorization status with respect to address book data. More...
 
enum  eBillingTransactionState { PURCHASED, FAILED, RESTORED, REFUNDED }
 The state of a billing product payment. More...
 
enum  eBillingTransactionVerificationState { NOT_CHECKED, SUCCESS, FAILED }
 The state of a payment receipt verification. More...
 
enum  eCloudDataStoreValueChangeReason { SERVER, INITIAL_SYNC, QUOTA_VIOLATION, STORE_ACCOUNT }
 Possible reasons when cloud data changed event occurs. More...
 
enum  eLeaderboardUserScope { GLOBAL, FRIENDS_ONLY }
 The scope of user to be searched for scores. More...
 
enum  eLeaderboardTimeScope { TODAY, WEEK, ALL_TIME }
 The period of time to which user's best score are restricted. More...
 
enum  eLeaderboardPageDirection { NEXT, PREVIOUS }
 Defines direction constants for pagination over leaderboard score data sets. More...
 
enum  eImageSource { ALBUM, CAMERA, BOTH }
 Defines sources available to pick an image. More...
 
enum  ePickImageFinishReason { SELECTED, CANCELLED, FAILED }
 Constants describing the reason that caused image picker view to dismiss. More...
 
enum  ePickVideoFinishReason { SELECTED, CANCELLED, FAILED }
 Constants describing the reason that caused video picker view to dismiss. More...
 
enum  ePlayVideoFinishReason { PLAYBACK_ENDED, PLAYBACK_ERROR, USER_EXITED }
 Constants describing the reason that caused video playback to end. More...
 
enum  NotificationType { Badge = 1, Sound, Alert = 4 }
 Defines possible options to alert user when a local or push notification arrives. More...
 
enum  eNotificationRepeatInterval {
  NONE = 0, MINUTE, HOUR, DAY,
  WEEK, MONTH, YEAR
}
 Defines possible intevals at which the notification can be rescheduled. More...
 
enum  eShareOptions { ,
  MESSAGE, MAIL, FB, TWITTER,
  WHATSAPP
}
 The services available for sharing contents from your application. More...
 
enum  eShareResult { CLOSED }
 Possible values for the result, when composer view is dismissed. More...
 
enum  eTwitterComposerResult { CANCELLED, DONE }
 Possible values for the result, when composer view is dismissed. More...
 
enum  eToastMessageLength { SHORT, LONG }
 Possible values that determine toast display time length. More...
 
enum  eWebviewControlType { NO_CONTROLS, CLOSE_BUTTON, TOOLBAR }
 Specifies the appearence options available for web view. More...
 

Enumeration Type Documentation

Different possible values for the authorization status with respect to address book data.

Enumerator
NOT_DETERMINED 

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.

The state of a billing product payment.

Enumerator
PURCHASED 

The Store successfully processed payment.

FAILED 

The transaction failed.

RESTORED 

This transaction restores content previously purchased by the user.

REFUNDED 

This transaction was refunded back to the user. You can restrict/remove associated item.

The state of a payment receipt verification.

Enumerator
NOT_CHECKED 

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.

Possible reasons when cloud data changed event occurs.

Enumerator
SERVER 

This occurs when another instance of your app using same cloud service account, uploads a new value.

INITIAL_SYNC 

This occurs when an attempt to write to key-value storage was discarded because an initial download from cloud server has not yet happened.

QUOTA_VIOLATION 

This occurs when your app’s key-value store has exceeded its space quota on the cloud server.

STORE_ACCOUNT 

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.

enum eLeaderboardUserScope
strong

The scope of user to be searched for scores.

Enumerator
GLOBAL 

All the user's are considered for search.

FRIENDS_ONLY 

Only friends of local user are considered for search.

enum eLeaderboardTimeScope
strong

The period of time to which user's best score are restricted.

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.

ALL_TIME 

Best score of all user's recorded is returned.

Defines direction constants for pagination over leaderboard score data sets.

Enumerator
NEXT 

Direction advancing toward the end of the data.

PREVIOUS 

Direction advancing toward the beginning of the data.

enum eImageSource
strong

Defines sources available to pick an image.

Enumerator
ALBUM 

Specifies the device's photo album as source for picking image.

CAMERA 

Specifies the device's camera as source for picking image.

BOTH 

Specifies the device's photo album and camera as source for picking image.

Constants describing the reason that caused image picker view to dismiss.

Enumerator
SELECTED 

The image was selected from specified eImageSource.

CANCELLED 

The user cancelled the operation.

FAILED 

The image was not picked or saved, possibly due to an error.

Constants describing the reason that caused video picker view to dismiss.

Enumerator
SELECTED 

The video was selected from gallery.

CANCELLED 

The user cancelled the operation.

FAILED 

The video was not picked, possibly due to an error.

Constants describing the reason that caused video playback to end.

Enumerator
PLAYBACK_ENDED 

The end of the video was reached.

PLAYBACK_ERROR 

There was an error during playback.

USER_EXITED 

The user exited without playing the complete video.

enum NotificationType
strong

Defines possible options to alert user when a local or push notification arrives.

Enumerator
Badge 

Badges the icon.

Sound 

Plays a sound.

Alert 

Displays an alert message.

Defines possible intevals at which the notification can be rescheduled.

Enumerator
NONE 

The system fires the notification once and then discards it.

MINUTE 

The system reschedules the notification delivery for every minute.

HOUR 

The system reschedules the notification delivery for every hour.

DAY 

The system reschedules the notification delivery for every day.

WEEK 

The system reschedules the notification delivery for every week.

MONTH 

The system reschedules the notification delivery for every month.

YEAR 

The system reschedules the notification delivery for every year.

enum eShareOptions
strong

The services available for sharing contents from your application.

Enumerator
MESSAGE 

Share via messaging service. Can be SMS/MMS or Messager apps on Tablets.

MAIL 

Share via email service.

FB 

Share via Facebook service.

TWITTER 

Share via Twitter service.

WHATSAPP 

Share via WhatsApp service.

enum eShareResult
strong

Possible values for the result, when composer view is dismissed.

Enumerator
CLOSED 

The composer view is dismissed.

Possible values for the result, when composer view is dismissed.

Enumerator
CANCELLED 

The composer is dismissed without sending the Tweet (i.e. the user selects Cancel, or the account is unavailable).

DONE 

The composer is dismissed and the message is being sent in the background.

enum eToastMessageLength
strong

Possible values that determine toast display time length.

Enumerator
SHORT 

Show the toast message for a short period of time.

LONG 

Show the toast message for a long period of time.

enum eWebviewControlType
strong

Specifies the appearence options available for web view.

Enumerator
NO_CONTROLS 

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

CLOSE_BUTTON 

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

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.