Class ExternalProvider

Hierarchy (View Summary)

Model<ExternalProviderAttributes>
- ExternalProvider

Constructors

constructor

new ExternalProvider(
attributes?: Partial<ExternalProviderAttributes>,
options?: any,
): ExternalProvider
Parameters
- Optionalattributes: Partial<ExternalProviderAttributes>
- Optionaloptions: any
Returns ExternalProvider
Inherited from Backbone.Model<ExternalProviderAttributes>.constructor

Properties

attributes

attributes: any

changed

changed: any[]

cid

cid: string

cidPrefix

cidPrefix: string

collection

collection: Collection<any>

id

id: any

idAttribute

idAttribute: string

url

url: () => string

Returns the relative URL where the model's resource would be located on the server.

Memberof

Model

urlRoot

urlRoot: any

validationError

validationError: any

Methods

bind

bind(eventName: string, callback: EventHandler, context?: any): this
Parameters
- eventName: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Inherited from Backbone.Model.bind
bind(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Inherited from Backbone.Model.bind

chain

chain(): any
Returns any
Inherited from Backbone.Model.chain

changedAttributes

changedAttributes(attributes?: any): any
Return an object containing all the attributes that have changed, or false if there are no changed attributes. Useful for determining what parts of a view need to be updated and/or what attributes need to be persisted to the server. Unset attributes will be set to undefined. You can also pass an attributes object to diff against the model, determining if there would be a change.
Parameters
- Optionalattributes: any
Returns any
Inherited from Backbone.Model.changedAttributes

clear

clear(options?: Silenceable): any
Parameters
- Optionaloptions: Silenceable
Returns any
Inherited from Backbone.Model.clear

clone

clone(): Model
Returns Model
Inherited from Backbone.Model.clone

defaults

defaults(): { location: null; name: null; url: null; uuid: null }
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 { location: null; name: null; url: null; uuid: null }
Overrides Backbone.Model.defaults

destroy

destroy(options?: ModelDestroyOptions): any
Parameters
- Optionaloptions: ModelDestroyOptions
Returns any
Inherited from Backbone.Model.destroy

escape

escape(attribute: string): string
Parameters
- attribute: string
Returns string
Inherited from Backbone.Model.escape

fetch

fetch(options?: ModelFetchOptions): JQueryXHR
Parameters
- Optionaloptions: ModelFetchOptions
Returns JQueryXHR
Inherited from Backbone.Model.fetch

get

get<a extends "name" | "url" | "uuid" | "location">(
attributeName: a,
): ExternalProviderAttributes[a]
For strongly-typed access to attributes, use the get method only privately in public getter properties.
Type Parameters
- a extends "name" | "url" | "uuid" | "location"
Parameters
- attributeName: a
Returns ExternalProviderAttributes[a]
Example
```
get name(): string {
   return super.get("name");
}
```
Inherited from Backbone.Model.get

getName

getName(): string
Returns string

has

has(attribute: string): boolean
Parameters
- attribute: string
Returns boolean
Inherited from Backbone.Model.has

hasChanged

hasChanged(attribute?: string): boolean
Parameters
- Optionalattribute: string
Returns boolean
Inherited from Backbone.Model.hasChanged

initialize

initialize(): undefined | Model<any, ModelSetOptions>
Returns undefined | Model<any, ModelSetOptions>
Overrides Backbone.Model.initialize

invert

invert(): any
Returns any
Inherited from Backbone.Model.invert

isEmpty

isEmpty(): boolean
Returns boolean
Inherited from Backbone.Model.isEmpty

isNew

isNew(): boolean
Returns boolean
Inherited from Backbone.Model.isNew

isValid

isValid(options?: any): boolean
Parameters
- Optionaloptions: any
Returns boolean
Inherited from Backbone.Model.isValid

keys

keys(): string[]
Returns string[]
Inherited from Backbone.Model.keys

listenTo

listenTo(object: any, events: string, callback: EventHandler): this
Parameters
- object: any
- events: string
- callback: EventHandler
Returns this
Inherited from Backbone.Model.listenTo
listenTo(object: any, eventMap: EventMap): this
Parameters
- object: any
- eventMap: EventMap
Returns this
Inherited from Backbone.Model.listenTo

listenToOnce

listenToOnce(object: any, events: string, callback: EventHandler): this
Parameters
- object: any
- events: string
- callback: EventHandler
Returns this
Inherited from Backbone.Model.listenToOnce
listenToOnce(object: any, eventMap: EventMap): this
Parameters
- object: any
- eventMap: EventMap
Returns this
Inherited from Backbone.Model.listenToOnce

matches

matches(attrs: any): boolean
Parameters
- attrs: any
Returns boolean
Inherited from Backbone.Model.matches

off

off(eventName?: string, callback?: EventHandler, context?: any): this
Parameters
- OptionaleventName: string
- Optionalcallback: EventHandler
- Optionalcontext: any
Returns this
Inherited from Backbone.Model.off

omit

omit(keys: string[]): any
Parameters
- keys: string[]
Returns any
Inherited from Backbone.Model.omit
omit(...keys: string[]): any
Parameters
- ...keys: string[]
Returns any
Inherited from Backbone.Model.omit
omit(fn: (value: any, key: any, object: any) => any): any
Parameters
- fn: (value: any, key: any, object: any) => any
Returns any
Inherited from Backbone.Model.omit

on

on(eventName: string, callback: EventHandler, context?: any): this
Parameters
- eventName: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Inherited from Backbone.Model.on
on(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Inherited from Backbone.Model.on

once

once(events: string, callback: EventHandler, context?: any): this
Parameters
- events: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Inherited from Backbone.Model.once
once(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Inherited from Backbone.Model.once

pairs

pairs(): any[]
Returns any[]
Inherited from Backbone.Model.pairs

parse

parse(response: any, options?: any): any
Parameters
- response: any
- Optionaloptions: any
Returns any
Inherited from Backbone.Model.parse

pick

pick(keys: string[]): any
Parameters
- keys: string[]
Returns any
Inherited from Backbone.Model.pick
pick(...keys: string[]): any
Parameters
- ...keys: string[]
Returns any
Inherited from Backbone.Model.pick
pick(fn: (value: any, key: any, object: any) => any): any
Parameters
- fn: (value: any, key: any, object: any) => any
Returns any
Inherited from Backbone.Model.pick

preinitialize

preinitialize(attributes?: ExternalProviderAttributes, options?: any): void
For use with models as ES classes. If you define a preinitialize method, it will be invoked when the Model is first created, before any instantiation logic is run for the Model.
Parameters
- Optionalattributes: ExternalProviderAttributes
- Optionaloptions: any
Returns void
See
https://backbonejs.org/#Model-preinitialize

Inherited from Backbone.Model.preinitialize

previous(attribute: string): any
Parameters
- attribute: string
Returns any
Inherited from Backbone.Model.previous

previousAttributes

previousAttributes(): any[]
Returns any[]
Inherited from Backbone.Model.previousAttributes

save

save(attributes?: any, options?: ModelSaveOptions): any
Parameters
- Optionalattributes: any
- Optionaloptions: ModelSaveOptions
Returns any
Inherited from Backbone.Model.save

set

set<a extends "name" | "url" | "uuid" | "location">(
    attributeName: a,
    value?: ExternalProviderAttributes[a],
    options?: ModelSetOptions,
): Model
For strongly-typed assignment of attributes, use the set method only privately in public setter properties.
Type Parameters
- a extends "name" | "url" | "uuid" | "location"
Parameters
- attributeName: a
- Optionalvalue: ExternalProviderAttributes[a]
- Optionaloptions: ModelSetOptions
Returns Model
Example
```
set name(value: string) {
   super.set("name", value);
}
```
Inherited from Backbone.Model.set
set(
attributeName: Partial<ExternalProviderAttributes>,
options?: ModelSetOptions,
): Model
For strongly-typed assignment of attributes, use the set method only privately in public setter properties.
Parameters
- attributeName: Partial<ExternalProviderAttributes>
- Optionaloptions: ModelSetOptions
Returns Model
Example
```
set name(value: string) {
   super.set("name", value);
}
```
Inherited from Backbone.Model.set
set<a extends "name" | "url" | "uuid" | "location">(
    attributeName: a | Partial<ExternalProviderAttributes>,
    value?: ModelSetOptions | ExternalProviderAttributes[a],
    options?: ModelSetOptions,
): Model
For strongly-typed assignment of attributes, use the set method only privately in public setter properties.
Type Parameters
- a extends "name" | "url" | "uuid" | "location"
Parameters
- attributeName: a | Partial<ExternalProviderAttributes>
- Optionalvalue: ModelSetOptions | ExternalProviderAttributes[a]
- Optionaloptions: ModelSetOptions
Returns Model
Example
```
set name(value: string) {
   super.set("name", value);
}
```
Inherited from Backbone.Model.set

stopListening

stopListening(object?: any, events?: string, callback?: EventHandler): this
Parameters
- Optionalobject: any
- Optionalevents: string
- Optionalcallback: EventHandler
Returns this
Inherited from Backbone.Model.stopListening

sync

sync(...arg: any[]): JQueryXHR
Parameters
- ...arg: any[]
Returns JQueryXHR
Inherited from Backbone.Model.sync

toJSON

toJSON(): string
Returns string
Overrides Backbone.Model.toJSON

trigger

trigger(eventName: string, ...args: any[]): this
Parameters
- eventName: string
- ...args: any[]
Returns this
Inherited from Backbone.Model.trigger

unbind

unbind(eventName?: string, callback?: EventHandler, context?: any): this
Parameters
- OptionaleventName: string
- Optionalcallback: EventHandler
- Optionalcontext: any
Returns this
Inherited from Backbone.Model.unbind

unset

unset(attribute: string, options?: Silenceable): Model
Parameters
- attribute: string
- Optionaloptions: Silenceable
Returns Model
Inherited from Backbone.Model.unset

validate

validate(attributes: any, options?: any): any
Parameters
- attributes: any
- Optionaloptions: any
Returns any
Inherited from Backbone.Model.validate

values

values(): any[]
Returns any[]
Inherited from Backbone.Model.values

`Static`extend

extend(properties: any, classProperties?: any): any
Do not use, prefer TypeScript's extend functionality.
Parameters
- properties: any
- OptionalclassProperties: any
Returns any
Inherited from Backbone.Model.extend

Class ExternalProvider

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ExternalProvider

Properties

attributes

changed

cid

cidPrefix

collection

id

idAttribute

url

Memberof

urlRoot

validationError

Methods

bind

Parameters

Returns this

Parameters

Returns this

chain

Returns any

changedAttributes

Parameters

Returns any

clear

Parameters

Returns any

clone

Returns Model

defaults

Returns { location: null; name: null; url: null; uuid: null }

destroy

Parameters

Returns any

escape

Parameters

Returns string

fetch

Parameters

Returns JQueryXHR

get

Type Parameters

Parameters

Returns ExternalProviderAttributes[a]

Example

getName

Returns string

has

Parameters

Returns boolean

hasChanged

Parameters

Returns boolean

initialize

Returns undefined | Model<any, ModelSetOptions>

invert

Returns any

isEmpty

Returns boolean

isNew

Returns boolean

isValid

Parameters

Returns boolean

keys

Returns string[]

listenTo

Parameters

Returns this

Parameters

Returns this