EngineDomain | @acaengine/ts-client

Hierarchy

EngineResource<EngineDomainsService>
- EngineDomain

Index

Constructors

constructor

Properties

Accessors

changes

Methods

Constructors

constructor

new EngineDomain(_service: EngineDomainsService, raw_data: HashMap): EngineDomain

Overrides EngineResource.constructor
- Defined in http/services/domains/domain.class.ts:21
Parameters
- _service: EngineDomainsService
- raw_data: HashMap
Returns EngineDomain

Properties

Protected _changes

_changes: HashMap

Map of unsaved property changes

Protected Optional _init_sub

_init_sub: Subscription

Subscription for initialisation events

Protected _server_names

_server_names: HashMap

Map of local property names to server ones

Protected _service

_service: EngineDomainsService

Protected _version

_version: number

Version of the data

changeEvents

changeEvents: Subject<EngineDataClassEvent> = new Subject<EngineDataClassEvent>()

Subject for change events to the class object

config

config: string

Local configuration for the domain

created_at

created_at: number

Unix epoch in seconds of the creation time of the object

description

description: string

Description of the domain domain

dom

dom: string

Domain name

id

id: string

Unique Identifier of the object

internals

internals: string

Internal settings for the domain

login_url

login_url: string

logout_url

logout_url: string

Logout URL for the domain

name

name: string

Human readable name of the object

Accessors

changes

get changes(): HashMap

Inherited from EngineResource.changes
- Defined in http/services/resources/resource.class.ts:24
Get map of changes to the resources

Returns HashMap

Methods

Protected change

change<U>(prop_name: string, value: U): void

Inherited from EngineResource.change
- Defined in http/services/resources/resource.class.ts:145
Update the value of a property

Type parameters
- U
Parameters
- prop_name: string
  
  Name of the property
- value: U
  
  New value for the property
Returns void

clearPendingChanges

clearPendingChanges(): void

Inherited from EngineResource.clearPendingChanges
- Defined in http/services/resources/resource.class.ts:65
Clear any pending changes to object

Returns void

delete

delete(): Promise<void>

Inherited from EngineResource.delete
- Defined in http/services/resources/resource.class.ts:111
Make request to delete the resource on the server

Returns Promise<void>

emit

emit(type: EngineDataEventType, metadata?: HashMap): void

Inherited from EngineResource.emit
- Defined in http/services/resources/resource.class.ts:76
Emits change event

Parameters
- type: EngineDataEventType
  
  Type of change that has occurred
- Default value metadata: HashMap = {}
  
  Supporting metadata for the event
Returns void

save

save(type?: "put" | "patch"): Promise<EngineDomainsService>

Inherited from EngineResource.save
- Defined in http/services/resources/resource.class.ts:83
Save any changes made to the server

Parameters
- Default value type: "put" | "patch" = "patch"
Returns Promise<EngineDomainsService>

storePendingChange

storePendingChange(key: DomainMutableFields, value: EngineDomain[DomainMutableFields]): this

Overrides EngineResource.storePendingChange
- Defined in http/services/domains/domain.class.ts:33
Parameters
- key: DomainMutableFields
- value: EngineDomain[DomainMutableFields]
Returns this

toJSON

toJSON(this: EngineResource<EngineDomainsService>, with_changes?: boolean): HashMap

Inherited from EngineResource.toJSON
- Defined in http/services/resources/resource.class.ts:118
Convert object into plain object

Parameters
- this: EngineResource<EngineDomainsService>
- Default value with_changes: boolean = true
Returns HashMap

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_service: EngineDomainsService

raw_data: HashMap

Returns EngineDomain

Properties

Protected _changes

Protected Optional _init_sub

Protected _server_names

Protected _service

Protected _version

changeEvents

config

created_at

description

dom

id

internals

login_url

logout_url

name

Accessors

changes

Returns HashMap

Methods

Protected change

Type parameters

U

Parameters

prop_name: string

value: U

Returns void

clearPendingChanges

Returns void

delete

Returns Promise<void>

emit

Parameters

type: EngineDataEventType

Default value metadata: HashMap = {}

Returns void

save

Parameters

Default value type: "put" | "patch" = "patch"

Returns Promise<EngineDomainsService>

storePendingChange

Parameters

key: DomainMutableFields

value: EngineDomain[DomainMutableFields]

Returns this

toJSON

Parameters

this: EngineResource<EngineDomainsService>

Default value with_changes: boolean = true

Returns HashMap