Home Manual Reference Source
public class | source

User

Extends:

ResourceBaseCrudBase → User

Static Member Summary

Static Public Members
public static get

Member Summary

Public Members
public get

Get the list colors linked to the user

public get

Get the list dimension sets linked to the user

public get

Get the list dimensions linked to the user

public get

Get the list features linked to the user

public get

Get the list font families linked to the user

public get

Get the list fonts linked to the user

public get

Get the list job shares linked to the user

public get

Get the list job types linked to the user

public get

Get the list jobs linked to the user

public get

Get the list layers linked to the user

public get

Get the list mapstyle sets linked to the user

public get

Get the list mapstyles linked to the user

public get

Get the list notifications linked to the user

public get

Get the list permissions linked to the user

public get

Get the list roles linked to the user

public get

Get the list svg sets linked to the user

public get

Get the list svgs linked to the user

Method Summary

Public Methods
public

async ips(): Promise<string[]>

Get all known ips

public

Get the user's language

public

Get the user's organisation

Inherited Summary

From class ResourceBase
public static get

Returns if the resource is readonly

public static get abstract

Resource name

public static get

Resource path template

public static get

Returns the url key of the resource

protected static get

Protected read-only fields

public get

Get api instance

public set

api(value: Maps4News)

Set the api instance

public get

Auto generated Resource base url

public get

List fields that contain object data

public get

If the resource can be owned by an organisation

public get

url: string: *

Auto generated resource url

public

Clone the object

public

async refresh(updateSelf: Boolean): Promise<ResourceBase>

Refresh the resource by requesting it from the server again

public

reset(fields: Array<string> | string | null)

Resets model instance to it's original state

public

Clean up instance and commit all changes locally.

public

static(Target: string | function, Constructor: function, seedData: Object<string, *>): SimpleResourceProxy

Static proxy generation

public

toObject(camelCaseKeys: boolean): {}

Transform instance to object

public

String representation of the resource, similar to Python's repr

protected

Macro for resource listing

protected

Moves new fields to this._properties and turns them into a getter/setter

From class CrudBase
public

async delete(updateSelf: Boolean): Promise<CrudBase>

Delete item

public

async restore(updateSelf: Boolean): Promise<CrudBase>

Restore item

public

Save item.

protected

Build data for create operation

Static Public Members

public static get resourceName: string source

Resource name

Override:

ResourceBase#resourceName

Public Members

public get colors: SimpleResourceProxy: * source

Get the list colors linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get dimensionSets: SimpleResourceProxy: * source

Get the list dimension sets linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get dimensions: SimpleResourceProxy: * source

Get the list dimensions linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get features: SimpleResourceProxy: * source

Get the list features linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get fontFamilies: SimpleResourceProxy: * source

Get the list font families linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get fonts: SimpleResourceProxy: * source

Get the list fonts linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get jobShares: SimpleResourceProxy: * source

Get the list job shares linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get jobTypes: SimpleResourceProxy: * source

Get the list job types linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get jobs: SimpleResourceProxy: * source

Get the list jobs linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get layers: SimpleResourceProxy: * source

Get the list layers linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get mapstyleSets: SimpleResourceProxy: * source

Get the list mapstyle sets linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get mapstyles: SimpleResourceProxy: * source

Get the list mapstyles linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get notifications: SimpleResourceProxy: * source

Get the list notifications linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get permissions: SimpleResourceProxy: * source

Get the list permissions linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get roles: OwnedResourceProxy: * source

Get the list roles linked to the user

Return:

OwnedResourceProxy

A proxy for accessing the resource

public get svgSets: SimpleResourceProxy: * source

Get the list svg sets linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get svgs: SimpleResourceProxy: * source

Get the list svgs linked to the user

Return:

SimpleResourceProxy

A proxy for accessing the resource

Public Methods

public async ips(): Promise<string[]> source

Get all known ips

Return:

Promise<string[]>

List of ip addresses

Throw:

ApiError

public language(): Promise<Language> source

Get the user's language

Return:

Promise<Language>

user's language

Throw:

ApiError

public organisation(): Promise<Organisation> source

Get the user's organisation

Return:

Promise<Organisation>

user's organisation

Throw:

ApiError