Class DeviceFactory

Hierarchy

EntityFactory<Device>
- DeviceFactory

Index

Constructors

constructor

new DeviceFactory(): DeviceFactory
Returns DeviceFactory

Inherited from EntityFactory.constructor

Properties

db

db: EntityManager = ...

The owning EntityManager where this factory belongs to

managedType

managedType: ManagedType<Device> = ...

The managed type of this factory

methods

methods: {
[methodName: string]: any;
} = ...

Methods that are added to object instances This property is an alias for this factory type prototype

Name

methods

Type declaration

[methodName: string]: any

prototype

prototype: Device = ...

type

type: Class<Device> = ...

Accessors

PushMessage

get PushMessage(): typeof PushMessage
Push message will be used to send a push notification to a set of devices

Returns typeof PushMessage
- Defined in lib/binding/DeviceFactory.ts:10

isRegistered

get isRegistered(): boolean
Returns true if the devices is already registered, otherwise false.

Returns boolean
- Defined in lib/binding/DeviceFactory.ts:26

me

get me(): null | Device
The current registered device, or null if the device is not registered

Returns null | Device
- Defined in lib/binding/DeviceFactory.ts:18

Methods

addMethod

addMethod(name: string, fn: Function): void
Add a method to instances of this factories type

Returns
Parameters
- name: string
  
  The method name to add
- fn: Function
  
  The Method to add
Returns void
Inherited from EntityFactory.addMethod
- Defined in lib/binding/ManagedFactory.ts:68

addMethods

addMethods(methods: {
[name: string]: Function;
}): void
Adds methods to instances of this factories type

Returns
Parameters
- methods: {
  [name: string]: Function;
  }
  
  The methods to add
  - [name: string]: Function
Returns void
Inherited from EntityFactory.addMethods
- Defined in lib/binding/ManagedFactory.ts:58

executeQuery

executeQuery(query: string, triggeredBy: string, ttl: string): Promise<any[]>
Executes a raw query for this class if the bucket supports it.
Parameters
- query: string
  
  The query to be executed
- triggeredBy: string
  
  Who or what triggered this query
- ttl: string
Returns Promise<any[]>
Inherited from EntityFactory.executeQuery
- Defined in lib/binding/EntityFactory.ts:86

find

find(): Builder<Device>
Creates a new query for this class

Returns
The query builder

Returns Builder<Device>
Inherited from EntityFactory.find
- Defined in lib/binding/EntityFactory.ts:67

fromJSON

fromJSON(json: Json): Device
Creates a new instance and sets the DatabaseObject to the given json

Returns
instance
Parameters
- json: Json
Returns Device
Inherited from EntityFactory.fromJSON
- Defined in lib/binding/EntityFactory.ts:58

load

load(id: string, options?: {
    depth?: number | boolean;
    local?: boolean;
    refresh?: boolean;
}, doneCallback?: any, failCallback?: any): Promise<null | Device>
Loads the instance for the given id, or null if the id does not exists.

Returns
A Promise that will be fulfilled when the asynchronous operation completes.
Parameters
- id: string
  
  The id to query
- Optional options: {
      depth?: number | boolean;
      local?: boolean;
      refresh?: boolean;
  }
  
  The load options
  - Optional depth?: number | boolean
    
    The object depth which will be loaded. Depth 0 loads only this object, true loads the objects by reachability.
  - Optional local?: boolean
    
    Indicates whether the local copy (from the entity manager) of an object should be returned if it exists. This value might be stale.
  - Optional refresh?: boolean
    
    Indicates whether the object should be revalidated (cache bypass).
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<null | Device>
Inherited from EntityFactory.load
- Defined in lib/binding/EntityFactory.ts:35

loadWebPushKey

loadWebPushKey(): Promise<ArrayBuffer>
Loads the Public VAPID Key which can be used to subscribe a Browser for Web Push notifications

Returns
The public VAPID Web Push subscription key

Returns Promise<ArrayBuffer>
- Defined in lib/binding/DeviceFactory.ts:34

new

new(...args: any[]): Device
Creates a new instance of the factory type

Returns
A new created instance of *

Instance
Parameters
- Rest ...args: any[]
  
  Constructor arguments used for instantiation
Returns Device
Inherited from EntityFactory.new
- Defined in lib/binding/Factory.ts:60

newInstance

newInstance(args?: IArguments | any[]): Device
Creates a new instance of the factory type

Returns
A new created instance of T
Parameters
- Optional args: IArguments | any[]
  
  Constructor arguments used for instantiation, the constructor will not be called when no arguments are passed
Returns Device
Inherited from EntityFactory.newInstance
- Defined in lib/binding/EntityFactory.ts:16

partialUpdate

partialUpdate(id: string, partialUpdate?: Json): EntityPartialUpdateBuilder<Device>
Creates a new partial update for this class

Returns
A partial update builder for the given entity id
Parameters
- id: string
  
  The id to partial update
- Optional partialUpdate: Json
  
  An initial partial update to execute
Returns EntityPartialUpdateBuilder<Device>
Inherited from EntityFactory.partialUpdate
- Defined in lib/binding/EntityFactory.ts:77

push

push(pushMessage: PushMessage, doneCallback?: any, failCallback?: any): Promise<void>
Uses the info from the given PushMessage message to send an push notification.

Returns
Parameters
- pushMessage: PushMessage
  
  to send an push notification.
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<void>
- Defined in lib/binding/DeviceFactory.ts:82

ref

ref(id: string): Device
Gets an unloaded reference for the given id.

Returns
An unloaded reference to the object with the given id.
Parameters
- id: string
  
  The id of an object to get a reference for.
Returns Device
Inherited from EntityFactory.ref
- Defined in lib/binding/EntityFactory.ts:49

register

register(os: string, tokenOrSubscription: string | PushSubscription, doneCallback?: any, failCallback?: any): Promise<Device>
Register a new device with the given device token and OS.

Returns
The registered device
Parameters
- os: string
  
  The OS of the device (IOS/Android)
- tokenOrSubscription: string | PushSubscription
  
  The FCM device token, APNS device token or WebPush subscription
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<Device>
- Defined in lib/binding/DeviceFactory.ts:48
register(os: string, tokenOrSubscription: string | PushSubscription, device: null | Device, doneCallback?: any, failCallback?: any): Promise<Device>
Register a new device with the given device token and OS.

Returns
The registered device
Parameters
- os: string
  
  The OS of the device (IOS/Android)
- tokenOrSubscription: string | PushSubscription
  
  The FCM device token, APNS device token or WebPush subscription
- device: null | Device
  
  An optional device entity to set custom field values
- Optional doneCallback: any
  
  Called when the operation succeed.
- Optional failCallback: any
  
  Called when the operation failed.
Returns Promise<Device>
- Defined in lib/binding/DeviceFactory.ts:61

`Static` create

create<T>(managedType: ManagedType<T>, db: EntityManager): ManagedFactory<T>
Creates a new ManagedFactory for the given type
Type Parameters
- T extends Managed<T>
Parameters
- managedType: ManagedType<T>
  
  The metadata of type T
- db: EntityManager
  
  The entity manager instance
Returns ManagedFactory<T>
Inherited from EntityFactory.create
- Defined in lib/binding/ManagedFactory.ts:14

`Static` `Protected` createFactory

createFactory<F, T>(this: Class<F>, type: Class<T>): F & InstanceFactory<T>
Creates a new Factory for the given type

Returns
A new object factory to created instances of T
Type Parameters
- F extends Factory<T, F>
- T
Parameters
- this: Class<F>
- type: Class<T>
  
  the type constructor of T
Returns F & InstanceFactory<T>
Inherited from EntityFactory.createFactory
- Defined in lib/binding/Factory.ts:37

Class DeviceFactory

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DeviceFactory

Properties

db

managedType

methods

Name

Type declaration

[methodName: string]: any

prototype

type

Accessors

PushMessage

Returns typeof PushMessage

isRegistered

Returns boolean

me

Returns null | Device

Methods

addMethod

Returns

Parameters

name: string

fn: Function

Returns void

addMethods

Returns

Parameters

methods: { [name: string]: Function; }

[name: string]: Function

Returns void

executeQuery

Parameters

query: string

triggeredBy: string

ttl: string

Returns Promise<any[]>

find

Returns

Returns Builder<Device>

fromJSON

Returns

Parameters

json: Json

Returns Device

load

Returns

Parameters

id: string

Optional options: { depth?: number | boolean; local?: boolean; refresh?: boolean; }

Optional depth?: number | boolean

Optional local?: boolean

Optional refresh?: boolean

Optional doneCallback: any

Optional failCallback: any

Returns Promise<null | Device>

loadWebPushKey

Returns

Returns Promise<ArrayBuffer>

new

Returns

Instance

Parameters

Rest ...args: any[]

Returns Device

newInstance

Returns

Parameters

Optional args: IArguments | any[]

Returns Device

partialUpdate

Returns

methods: {
[name: string]: Function;
}

`Optional` options: {
depth?: number | boolean;
local?: boolean;
refresh?: boolean;
}

`Optional` depth?: number | boolean

`Optional` local?: boolean

`Optional` refresh?: boolean

`Optional` doneCallback: any

`Optional` failCallback: any

`Rest` ...args: any[]

`Optional` args: IArguments | any[]

`Optional` partialUpdate: Json

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` doneCallback: any

`Optional` failCallback: any

`Static` create

`Static` `Protected` createFactory