Interface ICollection

Hierarchy

Index

Methods

Methods

public addRestangularMethod(name: string, operation: string, path?: string, params?: any, headers?: any, elem?: any): IPromise

Parameters

  • name: string
  • operation: string
  • path?: string optional
  • params?: any optional
  • headers?: any optional
  • elem?: any optional

Returns

IPromise

public all(route: string): IElement

Parameters

  • route: string

Returns

IElement

public allUrl(route: string, url: string): IElement

Parameters

  • route: string
  • url: string

Returns

IElement

public copy(fromElement: any): IElement

Parameters

  • fromElement: any

Returns

IElement

public customDELETE(path: string, params?: any, headers?: any): IPromise

Parameters

  • path: string
  • params?: any optional
  • headers?: any optional

Returns

IPromise

public customGET(path: string, params?: any, headers?: any): IPromise

Parameters

  • path: string
  • params?: any optional
  • headers?: any optional

Returns

IPromise

public customGETLIST(path: string, params?: any, headers?: any): ICollectionPromise

Parameters

  • path: string
  • params?: any optional
  • headers?: any optional

Returns

ICollectionPromise

public customOperation(operation: string, path: string, params?: any, headers?: any, elem?: any): IPromise

Parameters

  • operation: string
  • path: string
  • params?: any optional
  • headers?: any optional
  • elem?: any optional

Returns

IPromise

public customPOST(elem?: any, path?: string, params?: any, headers?: any): IPromise

Parameters

  • elem?: any optional
  • path?: string optional
  • params?: any optional
  • headers?: any optional

Returns

IPromise

public customPUT(elem?: any, path?: string, params?: any, headers?: any): IPromise

Parameters

  • elem?: any optional
  • path?: string optional
  • params?: any optional
  • headers?: any optional

Returns

IPromise

public getList(queryParams?: any, headers?: any): ICollectionPromise

Parameters

  • queryParams?: any optional
  • headers?: any optional

Returns

ICollectionPromise

public getRestangularUrl(): string

Returns

string

public head(queryParams?: any, headers?: any): IPromise

Parameters

  • queryParams?: any optional
  • headers?: any optional

Returns

IPromise

public one(route: string, id?: number): IElement

Parameters

  • route: string
  • id?: number optional

Returns

IElement

public one(route: string, id?: string): IElement

Parameters

  • route: string
  • id?: string optional

Returns

IElement

public oneUrl(route: string, url: string): IElement

Parameters

  • route: string
  • url: string

Returns

IElement

public options(queryParams?: any, headers?: any): IPromise

Parameters

  • queryParams?: any optional
  • headers?: any optional

Returns

IPromise

public patch(queryParams?: any, headers?: any): IPromise

Parameters

  • queryParams?: any optional
  • headers?: any optional

Returns

IPromise

public post(elementToPost: any, queryParams?: any, headers?: any): IPromise

Parameters

  • elementToPost: any
  • queryParams?: any optional
  • headers?: any optional

Returns

IPromise

public putElement(idx: any, params: any, headers: any): IPromise

Parameters

  • idx: any
  • params: any
  • headers: any

Returns

IPromise

public restangularizeCollection(parent: any, element: any, route: string): ICollection

Parameters

  • parent: any
  • element: any
  • route: string

Returns

ICollection

public restangularizeElement(parent: any, element: any, route: string, collection?: any, reqParams?: any): IElement

Parameters

  • parent: any
  • element: any
  • route: string
  • collection?: any optional
  • reqParams?: any optional

Returns

IElement

public stripRestangular(element: any): any

Parameters

  • element: any

Returns

any

public trace(queryParams?: any, headers?: any): IPromise

Parameters

  • queryParams?: any optional
  • headers?: any optional

Returns

IPromise

public withConfig(configurer: (RestangularProvider: restangular.IProvider) => any): IService

Parameters

  • configurer: (RestangularProvider: restangular.IProvider) => any

Returns

IService

public withHttpConfig(httpConfig: IRequestConfig): ICollection

Parameters

Returns

ICollection