BatchSDK.Batch Class Reference

Batch SDK Core More...

Public Member Functions
void	SetDebugWriter (DebugLineWriter writer)
	Set a debug line writer to which Batch will send state and debug logs. More...
void	Start (string apiKey)
	Start Batch with the provided API Key. You can find it in your app's settings on Batch's dashboard. More...
void	HandleApplicationStart (string launchString)
	Call this method in your Application subclass' OnLaunched and OnActivated with the launch string More...

Public Attributes
bool	Started => SdkCore.Instance.State == State.Started
	Returns whether the SDK has been started or not More...
string	Version => Configuration.PublicVersionName
	SDK Version More...

Static Public Attributes
static Batch	Core => LazyInstance.Value
	Batch's core. Your main entry point with the SDK. More...
static Push.Push	Push => BatchSDK.Push.Push.Instance
	Batch's Push module. More...
static User.User	User => BatchSDK.User.User.Instance
	Batch's User module. More...

Properties
bool	EnableDebugLogs [get, set]
	Controls the output of debug logs. Enabled by default. More...
bool	CanUseAdvertisingId [get, set]
	Specify whether you allow Batch to collect the user's advertising id or not. Enabled by default.If the user disabled the Advertising Id in the settings, it will not be collected irregardles of this setting. More...

Detailed Description

Batch SDK Core

Version 1.5.0 RC 2

Member Function Documentation

void BatchSDK.Batch.HandleApplicationStart

(

string

launchString

)

Call this method in your Application subclass' OnLaunched and OnActivated with the launch string

void BatchSDK.Batch.SetDebugWriter

(

DebugLineWriter

writer

)

Set a debug line writer to which Batch will send state and debug logs.

Also see

See also

EnableDebugLogs

Parameters

writer

void BatchSDK.Batch.Start

(

string

apiKey

)

Start Batch with the provided API Key. You can find it in your app's settings on Batch's dashboard.

Member Data Documentation

Batch BatchSDK.Batch.Core => LazyInstance.Value

static

Batch's core. Your main entry point with the SDK.

Push.Push BatchSDK.Batch.Push => BatchSDK.Push.Push.Instance

static

Batch's Push module.

bool BatchSDK.Batch.Started => SdkCore.Instance.State == State.Started

Returns whether the SDK has been started or not

User.User BatchSDK.Batch.User => BatchSDK.User.User.Instance

static

Batch's User module.

string BatchSDK.Batch.Version => Configuration.PublicVersionName

SDK Version

Property Documentation

bool BatchSDK.Batch.CanUseAdvertisingId

getset

Specify whether you allow Batch to collect the user's advertising id or not. Enabled by default.If the user disabled the Advertising Id in the settings, it will not be collected irregardles of this setting.

bool BatchSDK.Batch.EnableDebugLogs

getset

Controls the output of debug logs. Enabled by default.

Even if you disable this, Batch will still write some logs related to normal operation. Debug logs provide an additional verbosity that you can disable.