Class Model

extension of a backbone.js Model.

Hierarchy

Model
- Model
  - LiveDataMessageModel

Hierarchy-Diagram

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Model(attributes?: any, options?: any): Model

Overwrites Model.__constructor
- Defined in livedata/Model.ts:79
Parameters
- Optional attributes: any
- Optional options: any
Returns Model

Properties

_type

_type: string

attributes

attributes: any

changed

changed: any[]

changedSinceSync

changedSinceSync: object

Type declaration

cid

cid: string

collection

collection: Collection

credentials

credentials: any

endpoint

endpoint: SyncEndpoint

entity

entity: string

id

id: any

idAttribute

idAttribute: string

isCollection

isCollection: boolean

isModel

isModel: boolean

isStore

isStore: boolean

store

store: Store

url

url: any

urlRoot

urlRoot: any

validationError

validationError: any

Methods

ajax

ajax(options: any): any

- Defined in livedata/Model.ts:108
Parameters
- options: any
Returns any

bind

bind(eventName: string, callback: Function, context?: any): any

Inherited from Events.bind
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:82
Parameters
- eventName: string
- callback: Function
- Optional context: any
Returns any

chain

chain(): any

Inherited from Model.chain
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:174
Returns any

changedAttributes

changedAttributes(attributes?: any): any[]

Inherited from Model.changedAttributes
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:145
Parameters
- Optional attributes: any
Returns any[]

clear

clear(options?: Silenceable): any

Inherited from Model.clear
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:146
Parameters
- Optional options: Silenceable
Returns any

clone

clone(): Model

Inherited from Model.clone
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:147
Returns Model

defaults

defaults(): ObjectHash

Inherited from Model.defaults
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:115
Default attributes for the model. It can be an object hash or a method returning an object hash. For assigning an object hash, do it like this: this.defaults = { attribute: value, ... }; That works only if you set it in the constructor or the initialize method.

Returns ObjectHash

destroy

destroy(options?: ModelDestroyOptions): any

Inherited from Model.destroy
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:148
Parameters
- Optional options: ModelDestroyOptions
Returns any

escape

escape(attribute: string): string

Inherited from Model.escape
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:149
Parameters
- attribute: string
Returns string

fetch

fetch(options?: ModelFetchOptions): JQueryXHR

Inherited from Model.fetch
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:124
Parameters
- Optional options: ModelFetchOptions
Returns JQueryXHR

get

get(attributeName: string): any

Inherited from Model.get
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:133
For strongly-typed access to attributes, use the get method only privately in public getter properties.

example

get name(): string { return super.get("name"); }

Parameters
- attributeName: string
Returns any

getUrlRoot

getUrlRoot(): string

- Defined in livedata/Model.ts:129
Returns string

has

has(attribute: string): boolean

Inherited from Model.has
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:150
Parameters
- attribute: string
Returns boolean

hasChanged

hasChanged(attribute?: string): boolean

Inherited from Model.hasChanged
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:151
Parameters
- Optional attribute: string
Returns boolean

Protected init

init(attributes?: any, options?: any): void

- Defined in livedata/Model.ts:93
Parameters
- Optional attributes: any
- Optional options: any
Returns void

initialize

initialize(attributes?: any, options?: any): void

Inherited from Model.initialize
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:122
Parameters
- Optional attributes: any
- Optional options: any
Returns void

invert

invert(): any

Inherited from Model.invert
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:167
Returns any

isEmpty

isEmpty(): boolean

Inherited from Model.isEmpty
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:175
Returns boolean

isNew

isNew(): boolean

Inherited from Model.isNew
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:152
Returns boolean

isValid

isValid(options?: any): boolean

Inherited from Model.isValid
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:153
Parameters
- Optional options: any
Returns boolean

keys

keys(): string[]

Inherited from Model.keys
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:164
Returns string[]

listenTo

listenTo(object: any, events: string, callback: Function): any

Inherited from Events.listenTo
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:86
Parameters
- object: any
- events: string
- callback: Function
Returns any

listenToOnce

listenToOnce(object: any, events: string, callback: Function): any

Inherited from Events.listenToOnce
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:87
Parameters
- object: any
- events: string
- callback: Function
Returns any

off

off(eventName?: string, callback?: Function, context?: any): any

Inherited from Events.off
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:80
Parameters
- Optional eventName: string
- Optional callback: Function
- Optional context: any
Returns any

omit

omit(keys: string[]): any
omit(...keys: string[]): any
omit(fn: function): any

Inherited from Model.omit
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:171
Parameters
- keys: string[]
Returns any
Inherited from Model.omit
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:172
Parameters
- Rest ...keys: string[]
Returns any
Inherited from Model.omit
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:173
Parameters
- fn: function
  - - (value: any, key: any, object: any): any
    - Parameters
      - value: any
      - key: any
      - object: any
      Returns any
Returns any

on

on(eventName: string, callback?: Function, context?: any): any
on(eventMap: EventsHash): any

Inherited from Events.on
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:78
Parameters
- eventName: string
- Optional callback: Function
- Optional context: any
Returns any
Inherited from Events.on
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:79
Parameters
- eventMap: EventsHash
Returns any

onChange

onChange(model: Model, options: any): void

- Defined in livedata/Model.ts:115
Parameters
- model: Model
- options: any
Returns void

onSync

onSync(model: Model, options: any): void

- Defined in livedata/Model.ts:125
Parameters
- model: Model
- options: any
Returns void

once

once(events: string, callback: Function, context?: any): any

Inherited from Events.once
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:85
Parameters
- events: string
- callback: Function
- Optional context: any
Returns any

pairs

pairs(): any[]

Inherited from Model.pairs
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:166
Returns any[]

parse

parse(response: any, options?: any): any

Inherited from ModelBase.parse
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:93
Parameters
- response: any
- Optional options: any
Returns any

pick

pick(keys: string[]): any
pick(...keys: string[]): any
pick(fn: function): any

Inherited from Model.pick
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:168
Parameters
- keys: string[]
Returns any
Inherited from Model.pick
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:169
Parameters
- Rest ...keys: string[]
Returns any
Inherited from Model.pick
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:170
Parameters
- fn: function
  - - (value: any, key: any, object: any): any
    - Parameters
      - value: any
      - key: any
      - object: any
      Returns any
Returns any

previous

previous(attribute: string): any

Inherited from Model.previous
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:154
Parameters
- attribute: string
Returns any

previousAttributes

previousAttributes(): any[]

Inherited from Model.previousAttributes
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:155
Returns any[]

save

save(attributes?: any, options?: ModelSaveOptions): any

Inherited from Model.save
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:156
Parameters
- Optional attributes: any
- Optional options: ModelSaveOptions
Returns any

set

set(attributeName: string, value: any, options?: ModelSetOptions): Model
set(obj: any, options?: ModelSetOptions): Model

Inherited from Model.set
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:142
For strongly-typed assignment of attributes, use the set method only privately in public setter properties.

example

set name(value: string) { super.set("name", value); }

Parameters
- attributeName: string
- value: any
- Optional options: ModelSetOptions
Returns Model
Inherited from Model.set
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:143
Parameters
- obj: any
- Optional options: ModelSetOptions
Returns Model

stopListening

stopListening(object?: any, events?: string, callback?: Function): any

Inherited from Events.stopListening
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:88
Parameters
- Optional object: any
- Optional events: string
- Optional callback: Function
Returns any

sync

sync(method: string, model: ModelBase, options?: any): any

Overwrites ModelBase.sync
- Defined in livedata/Model.ts:111
Parameters
- method: string
- model: ModelBase
- Optional options: any
Returns any

toJSON

toJSON(options?: any): any

Inherited from ModelBase.toJSON
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:94
Parameters
- Optional options: any
Returns any

trigger

trigger(eventName: string, ...args: any[]): any

Inherited from Events.trigger
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:81
Parameters
- eventName: string
- Rest ...args: any[]
Returns any

unbind

unbind(eventName?: string, callback?: Function, context?: any): any

Inherited from Events.unbind
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:83
Parameters
- Optional eventName: string
- Optional callback: Function
- Optional context: any
Returns any

unset

unset(attribute: string, options?: Silenceable): Model

Inherited from Model.unset
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:157
Parameters
- attribute: string
- Optional options: Silenceable
Returns Model

validate

validate(attributes: any, options?: any): any

Inherited from Model.validate
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:158
Parameters
- attributes: any
- Optional options: any
Returns any

values

values(): any[]

Inherited from Model.values
- Defined in D:/gofer-core/gofer-workspace/relution-sdk/typings/globals/backbone-global/index.d.ts:165
Returns any[]

Generated using TypeDoc