Home Manual Reference Source Repository
import OwnedResourceProxy from '@mapcreator/api/src/proxy/OwnedResourceProxy.js'
public class | source

OwnedResourceProxy

Extends:

SimpleResourceProxy → OwnedResourceProxy

Used for proxying resource => organisation

Constructor Summary

Public Constructor
public

constructor(api: Mapcreator, parent: ResourceBase, Target: Class<ResourceBase>)

OwnedResourceProxy Constructor

Method Summary

Public Methods
public

Attach items to the organisation

public

Attach parent resource to all organisations

public

Detach items from the organisation

public

Detach parent resource to all organisations

public

Sync items to the organisation

Inherited Summary

From class SimpleResourceProxy
public get

Target: Class<ResourceBase>: *

Target to wrap results in

public get

api: Mapcreator: *

Get api instance

public get

Proxy target url

public

List target resource

public

Get the resource lister

public

Build a new instance of the target

Public Constructors

public constructor(api: Mapcreator, parent: ResourceBase, Target: Class<ResourceBase>) source

OwnedResourceProxy Constructor

Override:

SimpleResourceProxy#constructor

Params:

NameTypeAttributeDescription
api Mapcreator

Api instance

parent ResourceBase

Parent instance

Target Class<ResourceBase>

Target constructor

Public Methods

public attach(items: ResourceBase): CancelablePromise source

Attach items to the organisation

Params:

NameTypeAttributeDescription
items ResourceBase

List of items to attach

Throw:

TypeError

ApiError

If the api returns errors

public attachAll(): CancelablePromise source

Attach parent resource to all organisations

Throw:

ApiError

If the api returns errors

public detach(items: ResourceBase): CancelablePromise source

Detach items from the organisation

Params:

NameTypeAttributeDescription
items ResourceBase

List of items to unlink

Throw:

TypeError

ApiError

If the api returns errors

public detachAll(): CancelablePromise source

Detach parent resource to all organisations

Throw:

ApiError

If the api returns errors

public sync(items: ResourceBase): CancelablePromise source

Sync items to the organisation

Params:

NameTypeAttributeDescription
items ResourceBase

List of items to sync

Throw:

TypeError

ApiError

If the api returns errors