Class Contacts

public static addAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends an after event handler

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event to listen for.

• fn?: any optional

  Function/String The method the event invokes.

• scope?: any optional

  Object The scope for fn.

• options?: any optional

  Object An object containing handler configuration.

public static addBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends a before event handler

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event to listen for.

• fn?: any optional

  Function/String The method the event invokes.

• scope?: any optional

  Object The scope for fn.

• options?: any optional

  Object An object containing handler configuration.

public static addEvents(eventNames?: any)

[Method] Adds the specified events to the list of events which this Observable may fire

Parameters

• eventNames?: any optional

  Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

public static addListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Appends an event handler to this object

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names.

• fn?: any optional

  Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope?: any optional

  Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options?: any optional

  Object An object containing handler configuration. This object may contain any of the following properties:

• order?: string optional

  String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

public static addManagedListener(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

• object?: any optional

  Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

• eventName?: any optional

  Object/String The event name, or an object containing event name properties.

• fn?: any optional

  Function If the eventName parameter was an event name, this is the handler function.

• scope?: any optional

  Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

• options?: any optional

  Object If the eventName parameter was an event name, this is the addListener options.

public static 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

public static 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

public static 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

public static clearListeners()

[Method] Removes all listeners for this object

public static destroy()

[Method]

public static enableBubble(events?: any)

[Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present

Parameters

• events?: any optional

  String/String[] The event name to bubble, or an Array of event names.

public static fireAction(eventName?: string, args?: Array<any>, fn?: any, scope?: any): any

[Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste

Parameters

• eventName?: string optional

  String The name of the event to fire.

• args?: Array<any> optional

  Array Arguments to pass to handers.

• fn?: any optional

  Function Action.

• scope?: any optional

  Object Scope of fn.

Returns

any

Object

public static fireEvent(eventName: string, args?: Array<any>): boolean

[Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList

Parameters

• eventName: string

  String The name of the event to fire.

• args?: Array<any> optional

  Object... Variable number of parameters are passed to handlers.

Returns

boolean

Boolean Returns false if any of the handlers return false.

public static getBubbleEvents(): any

[Method] Returns the value of bubbleEvents

Returns

any

String/String[]

public static getContacts(config?: any): Array<any>

[Method] Returns an Array of contact objects

Parameters

• config?: any optional

  Object

Returns

Array<any>

Object[] An array of contact objects.

public static getId(): string

[Method] Retrieves the id of this component

Returns

string

String id

public static getIncludeImages(): boolean

[Method] Returns the value of includeImages

Returns

boolean

Boolean

public static 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

public static getListeners(): any

[Method] Returns the value of listeners

Returns

any

Object

public static getLocalizedLabel(config?: any): string

[Method] Returns localized user readable label for a contact field i e

Parameters

• config?: any optional

  Object

Returns

string

String user readable string

public static getThumbnail(config?: any): string

[Method] Returns base64 encoded image thumbnail for a contact specified in config id This method is for Sencha Native Packager

Parameters

• config?: any optional

  Object

Returns

string

String base64 string

public static hasListener(eventName?: string): boolean

[Method] Checks to see if this object has any listeners for a specified event

Parameters

• eventName?: string optional

  String The name of the event to check for

Returns

boolean

Boolean True if the event is being listened for, else false

public static 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

public static mon(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addManagedListener

Parameters

• object?: any optional

  Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

• eventName?: any optional

  Object/String The event name, or an object containing event name properties.

• fn?: any optional

  Function If the eventName parameter was an event name, this is the handler function.

• scope?: any optional

  Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

• options?: any optional

  Object If the eventName parameter was an event name, this is the addListener options.

public static mun(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Alias for removeManagedListener

Parameters

• object?: any optional

  Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

• eventName?: any optional

  Object/String The event name, or an object containing event name properties.

• fn?: any optional

  Function If the eventName parameter was an event name, this is the handler function.

• scope?: any optional

  Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

public static on(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for addListener

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names.

• fn?: any optional

  Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope?: any optional

  Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options?: any optional

  Object An object containing handler configuration. This object may contain any of the following properties:

• order?: string optional

  String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

public static onAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addAfterListener

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event to listen for.

• fn?: any optional

  Function/String The method the event invokes.

• scope?: any optional

  Object The scope for fn.

• options?: any optional

  Object An object containing handler configuration.

public static onBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addBeforeListener

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event to listen for.

• fn?: any optional

  Function/String The method the event invokes.

• scope?: any optional

  Object The scope for fn.

• options?: any optional

  Object An object containing handler configuration.

public static relayEvents(object?: any, events?: any): IObservable

[Method] Relays selected events from the specified Observable as if the events were fired by this

Parameters

• object?: any optional

  Object The Observable whose events this object is to relay.

• events?: any optional

  String/Array/Object Array of event names to relay.

Returns

IObservable

Ext.mixin.Observable this

public static removeAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event the handler was associated with.

• fn?: any optional

  Function/String The handler to remove.

• scope?: any optional

  Object The scope originally specified for fn.

• options?: any optional

  Object Extra options object.

public static removeBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event the handler was associated with.

• fn?: any optional

  Function/String The handler to remove.

• scope?: any optional

  Object The scope originally specified for fn.

• options?: any optional

  Object Extra options object.

public static removeListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Removes an event handler

Parameters

• eventName?: any optional

  String/String[]/Object The type of event the handler was associated with.

• fn?: any optional

  Function/String The handler to remove. This must be a reference to the function passed into the addListener call.

• scope?: any optional

  Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

• options?: any optional

  Object Extra options object. See addListener for details.

• order?: string optional

  String The order of the listener to remove. Possible values are before, current and after.

public static removeManagedListener(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

• object?: any optional

  Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

• eventName?: any optional

  Object/String The event name, or an object containing event name properties.

• fn?: any optional

  Function If the eventName parameter was an event name, this is the handler function.

• scope?: any optional

  Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

public static resumeEvents(discardQueuedEvents?: boolean)

[Method] Resumes firing events see suspendEvents

Parameters

• discardQueuedEvents?: boolean optional

  Boolean Pass as true to discard any queued events.

public static setBubbleEvents(bubbleEvents?: any)

[Method] Sets the value of bubbleEvents

Parameters

• bubbleEvents?: any optional

  String/String[] The new value.

public static setIncludeImages(includeImages?: boolean)

[Method] Sets the value of includeImages

Parameters

• includeImages?: boolean optional

  Boolean The new value.

public static setListeners(listeners?: any)

[Method] Sets the value of listeners

Parameters

• listeners?: any optional

  Object The new value.

public static statics(): IClass

[Method] Get the reference to the class from which this object was instantiated

Returns

IClass

Ext.Class

public static suspendEvents()

[Method] Suspends the firing of all events

public static un(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for removeListener

Parameters

• eventName?: any optional

  String/String[]/Object The type of event the handler was associated with.

• fn?: any optional

  Function/String The handler to remove. This must be a reference to the function passed into the addListener call.

• scope?: any optional

  Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

• options?: any optional

  Object Extra options object. See addListener for details.

• order?: string optional

  String The order of the listener to remove. Possible values are before, current and after.

public static unAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeAfterListener

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event the handler was associated with.

• fn?: any optional

  Function/String The handler to remove.

• scope?: any optional

  Object The scope originally specified for fn.

• options?: any optional

  Object Extra options object.

public static unBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeBeforeListener

Parameters

• eventName?: any optional

  String/String[]/Object The name of the event the handler was associated with.

• fn?: any optional

  Function/String The handler to remove.

• scope?: any optional

  Object The scope originally specified for fn.

• options?: any optional

  Object Extra options object.