Interface IPhoneGap

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public allowHighAccuracy?: boolean

[Config Option] (Boolean)

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public extend?: string

[Config Option] (String)

optional public frequency?: number

[Config Option] (Number)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public maximumAge?: number

[Config Option] (Number)

optional public mixins?: any

[Config Option] (Object)

optional public platformConfig?: any

[Config Option] (Object)

optional public self?: IClass

[Property] (Ext.Class)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public statics?: any

[Config Option] (Object)

optional public timeout?: number

[Config Option] (Number)

optional public uses?: Array<string>

[Config Option] (String[])

Methods

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public clearWatch()

[Method] If you are currently watching for the current position this will stop that task

optional public destroy()

[Method]

optional public getAllowHighAccuracy(): boolean

[Method] Returns the value of allowHighAccuracy

Returns

boolean

Boolean

optional public getCurrentPosition(config?: any)

[Method] Attempts to get the current position of this device

Parameters

  • config?: any optional

    Object

optional public getFrequency(): number

[Method] Returns the value of frequency

Returns

number

Number

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getMaximumAge(): number

[Method] Returns the value of maximumAge

Returns

number

Number

optional public getTimeout(): number

[Method] Returns the value of timeout

Returns

number

Number

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public setAllowHighAccuracy(allowHighAccuracy?: boolean)

[Method] Sets the value of allowHighAccuracy

Parameters

  • allowHighAccuracy?: boolean optional

    Boolean The new value.

optional public setFrequency(frequency?: number)

[Method] Sets the value of frequency

Parameters

  • frequency?: number optional

    Number The new value.

optional public setMaximumAge(maximumAge?: number)

[Method] Sets the value of maximumAge

Parameters

  • maximumAge?: number optional

    Number The new value.

optional public setTimeout(timeout?: number)

[Method] Sets the value of timeout

Parameters

  • timeout?: number optional

    Number The new value.

optional public watchPosition(config?: any)

[Method] Watches for the current position and calls the callback when successful depending on the specified frequency

Parameters

  • config?: any optional

    Object