com.nifcloud.mbaas.core

Class NCMB

java.lang.Object

com.nifcloud.mbaas.core.NCMB

public class NCMB
extends java.lang.Object

The NCMB Class contains sdk initialize method and factory method for Service class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NCMB.ServiceType Service types

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_API_VERSION Default API version
static java.lang.String	DEFAULT_DOMAIN_URL Default base URL of API
static java.lang.String	METADATA_PREFIX Prefix of keys in metadata for NCMB settings
static java.lang.String	OAUTH_ANONYMOUS Anonymous authentication
static java.lang.String	OAUTH_FACEBOOK OAuth type of Facebook
static java.lang.String	OAUTH_GOOGLE OAuth type of Google
static java.lang.String	OAUTH_TWITTER OAuth type of Twitter
static java.lang.String	SDK_VERSION Version of this SDK
protected static NCMBServicePool	sServicePool service pool

Constructor Summary

Constructors

Constructor and Description
NCMB()

Method Summary

Modifier and Type	Method and Description
static void	enableResponseValidation(boolean responseValidation) Determining whether a response has not been tampered The default is invalid true = valid , false = inValid
static NCMBService	factory(NCMB.ServiceType serviceType) Create service instance from given type string
static NCMBContext	getCurrentContext() Get NCMBContext
protected static java.lang.String	getMetadata(android.content.Context context, java.lang.String name) Getting metadata from given context
static int	getTimeout() Getting time out
static void	initialize(android.content.Context context, java.lang.String applicationKey, java.lang.String clientKey) Setup SDK internals
static void	initialize(android.content.Context context, java.lang.String applicationKey, java.lang.String clientKey, java.util.Map<java.lang.String,java.lang.String> installationCustomFields) Setup SDK internals
static void	initialize(android.content.Context context, java.lang.String applicationKey, java.lang.String clientKey, java.lang.String domainUrl, java.lang.String apiVersion) Setup SDK internals with api server host name
static void	initialize(android.content.Context context, java.lang.String applicationKey, java.lang.String clientKey, java.lang.String domainUrl, java.lang.String apiVersion, java.util.Map<java.lang.String,java.lang.String> installationCustomFields) Setup SDK internals with api server host name
static void	setTimeout(int timeout) Setting time out Default 10000 milliseconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SDK_VERSION

public static final java.lang.String SDK_VERSION

Version of this SDK

See Also:

Constant Field Values

METADATA_PREFIX

public static final java.lang.String METADATA_PREFIX

Prefix of keys in metadata for NCMB settings

See Also:

Constant Field Values

DEFAULT_DOMAIN_URL

public static final java.lang.String DEFAULT_DOMAIN_URL

Default base URL of API

See Also:

Constant Field Values

DEFAULT_API_VERSION

public static final java.lang.String DEFAULT_API_VERSION

Default API version

See Also:

Constant Field Values

OAUTH_TWITTER

public static final java.lang.String OAUTH_TWITTER

OAuth type of Twitter

See Also:

Constant Field Values

OAUTH_FACEBOOK

public static final java.lang.String OAUTH_FACEBOOK

OAuth type of Facebook

See Also:

Constant Field Values

OAUTH_GOOGLE

public static final java.lang.String OAUTH_GOOGLE

OAuth type of Google

See Also:

Constant Field Values

OAUTH_ANONYMOUS

public static final java.lang.String OAUTH_ANONYMOUS

Anonymous authentication

See Also:

Constant Field Values

sServicePool

protected static NCMBServicePool sServicePool

service pool

Constructor Detail

NCMB

public NCMB()

Method Detail

initialize

public static void initialize(android.content.Context context,
                              java.lang.String applicationKey,
                              java.lang.String clientKey)

Setup SDK internals

Parameters:

context - Application context

applicationKey - application key

clientKey - client key

initialize

public static void initialize(android.content.Context context,
                              java.lang.String applicationKey,
                              java.lang.String clientKey,
                              java.util.Map<java.lang.String,java.lang.String> installationCustomFields)

Setup SDK internals

Parameters:

context - Application context

applicationKey - application key

clientKey - client key

installationCustomFields - installation custom fileds

initialize

public static void initialize(android.content.Context context,
                              java.lang.String applicationKey,
                              java.lang.String clientKey,
                              java.lang.String domainUrl,
                              java.lang.String apiVersion)

Setup SDK internals with api server host name

Parameters:

context - Application context

applicationKey - application key

clientKey - client key

domainUrl - host name for api request

apiVersion - version for rest api

initialize

public static void initialize(android.content.Context context,
                              java.lang.String applicationKey,
                              java.lang.String clientKey,
                              java.lang.String domainUrl,
                              java.lang.String apiVersion,
                              java.util.Map<java.lang.String,java.lang.String> installationCustomFields)

Setup SDK internals with api server host name

Parameters:

context - Application context

applicationKey - application key

clientKey - client key

domainUrl - host name for api request

apiVersion - version for rest api

installationCustomFields - installation custom fileds

factory

public static NCMBService factory(NCMB.ServiceType serviceType)
                           throws java.lang.IllegalArgumentException

Create service instance from given type string

Parameters:

serviceType - identifier for service API

Returns:

Object of each service class

Throws:

java.lang.IllegalArgumentException

getMetadata

protected static java.lang.String getMetadata(android.content.Context context,
                                              java.lang.String name)

Getting metadata from given context

Parameters:

context - Application context

name - Name of metadata

Returns:

String or null;

setTimeout

public static void setTimeout(int timeout)

Setting time out Default 10000 milliseconds

Parameters:

timeout - milliseconds

getTimeout

public static int getTimeout()

Getting time out

Returns:

timeout milliseconds

getCurrentContext

public static NCMBContext getCurrentContext()

Get NCMBContext

Returns:

sCurrentContext new NCMB context

enableResponseValidation

public static void enableResponseValidation(boolean responseValidation)

Determining whether a response has not been tampered
The default is invalid
true = valid , false = inValid

Parameters:

responseValidation - response validation enable flag