import SimpleResourceProxy from '@mapcreator/api/src/proxy/SimpleResourceProxy.js'

protected class | source

SimpleResourceProxy

Direct Subclass:

OrganisationProxy, OwnedResourceProxy, ResourceProxy

Indirect Subclass:

GeoResourceProxy

Proxy for accessing resource. This will make sure that they are properly wrapped before the promise resolves.

Constructor Summary

Public Constructor
public	constructor(api: Mapcreator, Target: Class<ResourceBase>, altUrl: string, seedData: object)

Member Summary

Public Members
public get	Target: Class<ResourceBase>: * Target to wrap results in
public get	api: Mapcreator: * Get api instance
public get	baseUrl: string: * Proxy target url

Method Summary

Public Methods
public	list(params: Number \| Object \| RequestParameters): CancelablePromise<PaginatedResourceListing> List target resource
public	lister(parameters: object \| RequestParameters, maxRows: number): ResourceLister Get the resource lister
public	new(data: Object<String, *>): ResourceBase Build a new instance of the target

Public Constructors

public constructor(api: Mapcreator, Target: Class<ResourceBase>, altUrl: string, seedData: object) source

Params:

Name	Type	Attribute	Description
api	Mapcreator		Instance of the api
Target	Class<ResourceBase>		Target to wrap
altUrl	string	optional default: null nullable: true	Internal use, Optional alternative url for more complex routing
seedData	object		Internal use, used for seeding ::new

Public Members

public get Target: Class<ResourceBase>: * source

Target to wrap results in

Return:

Class<ResourceBase>

Target constructor

public get api: Mapcreator: * source

Get api instance

Return:

Mapcreator

Api instance

public get baseUrl: string: * source

Proxy target url

Return:

string

url

Example:

api.layers.select(100).organisations.baseUrl === "https://maponline-api.dev/v1/layers/100/organisations"

Public Methods

public list(params: Number | Object | RequestParameters): CancelablePromise<PaginatedResourceListing> source

List target resource

Params:

Name	Type	Attribute	Description
params	Number \| Object \| RequestParameters	optional	Parameters or the page number to be requested
params.page	Number	optional default: 1	The page to be requested
params.perPage	Number	optional default: RequestParameters.perPage	Amount of items per page. This is silently capped by the API
params.sort	String \| String[]	optional default: ''	Amount of items per page. This is silently capped by the API
params.deleted	String	optional default: RequestParameters.deleted	Show deleted resources, posible values: only, none, all
params.search	Object<String, String\|Array<String>>	optional nullable: true	Search parameters

Return:

CancelablePromise<PaginatedResourceListing>

paginated resource

Throw:

ApiError

If the api returns errors

Example:

// Find layers with a name that starts with "test" and a scale_min between 1 and 10
// See Api documentation for search query syntax
const search = {
  name: '^:test',
  scale_min: ['>:1', '<:10'],
};

api.layers.list({perPage: 10, search});

public lister(parameters: object | RequestParameters, maxRows: number): ResourceLister source

Get the resource lister

Params:

Name	Type	Attribute	Description
parameters	object \| RequestParameters		parameters
maxRows	number		Maximum amount of rows

Return:

ResourceLister

Resource lister

public new(data: Object<String, *>): ResourceBase source

Build a new instance of the target

Params:

Name	Type	Attribute	Description
data	Object<String, *>		Data for the object to be populated with

Return:

ResourceBase

Resource with target data