Class PublishedRestResource

In version 10.4.0: deleted

Hierarchy

PublishedResource
- PublishedRestResource

Constructors

constructor

new PublishedRestResource(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit<IAbstractModel>, container: AbstractElement<IAbstractModel, Container>): PublishedRestResource

Overrides PublishedResource.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit<IAbstractModel>
- container: AbstractElement<IAbstractModel, Container>
Returns PublishedRestResource

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Rest$PublishedRestResource"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

get container(): TContainer

Inherited from webservices.PublishedResource.container
Returns TContainer

containerAsPublishedODataService

get containerAsPublishedODataService(): PublishedODataService

Overrides webservices.PublishedResource.containerAsPublishedODataService
Returns PublishedODataService

containerAsVersionedService

get containerAsVersionedService(): VersionedService

Inherited from webservices.PublishedResource.containerAsVersionedService
Returns VersionedService

countMicroflow

get countMicroflow(): null | IMicroflow
set countMicroflow(newValue: null | IMicroflow): void

In version 9.14.0: deleted In version 9.9.0: introduced

Returns null | IMicroflow
In version 9.14.0: deleted In version 9.9.0: introduced

Parameters
- newValue: null | IMicroflow
Returns void

countMicroflowQualifiedName

get countMicroflowQualifiedName(): null | string

Returns null | string

dataEntity

get dataEntity(): DataEntity
set dataEntity(newValue: DataEntity): void

Inherited from webservices.PublishedResource.dataEntity
Returns DataEntity
Inherited from webservices.PublishedResource.dataEntity
Parameters
- newValue: DataEntity
Returns void

deletable

get deletable(): boolean
set deletable(newValue: boolean): void

In version 9.11.0: deleted In version 9.10.0: introduced

Returns boolean
In version 9.11.0: deleted In version 9.10.0: introduced

Parameters
- newValue: boolean
Returns void

deleteMode

get deleteMode(): rest.ChangeMode
set deleteMode(newValue: rest.ChangeMode): void

In version 9.11.0: introduced

Returns rest.ChangeMode
In version 9.11.0: introduced

Parameters
- newValue: rest.ChangeMode
Returns void

description

get description(): string
set description(newValue: string): void

In version 8.0.0: introduced

Returns string
In version 8.0.0: introduced

Parameters
- newValue: string
Returns void

exposedName

get exposedName(): string
set exposedName(newValue: string): void

In version 7.19.0: introduced

Returns string
In version 7.19.0: introduced

Parameters
- newValue: string
Returns void

insertMode

get insertMode(): rest.ChangeMode
set insertMode(newValue: rest.ChangeMode): void

In version 9.11.0: introduced

Returns rest.ChangeMode
In version 9.11.0: introduced

Parameters
- newValue: rest.ChangeMode
Returns void

insertable

get insertable(): boolean
set insertable(newValue: boolean): void

In version 9.11.0: deleted In version 9.10.0: introduced

Returns boolean
In version 9.11.0: deleted In version 9.10.0: introduced

Parameters
- newValue: boolean
Returns void

isLoaded

get isLoaded(): boolean

Inherited from webservices.PublishedResource.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

model

get model(): TModel

Inherited from webservices.PublishedResource.model
Returns TModel

pageSize

get pageSize(): number
set pageSize(newValue: number): void

Returns number
Parameters
- newValue: number
Returns void

path

get path(): string
set path(newValue: string): void

Returns string
Parameters
- newValue: string
Returns void

queryMicroflow

get queryMicroflow(): null | IMicroflow
set queryMicroflow(newValue: null | IMicroflow): void

In version 9.14.0: deleted In version 9.9.0: introduced

Returns null | IMicroflow
In version 9.14.0: deleted In version 9.9.0: introduced

Parameters
- newValue: null | IMicroflow
Returns void

queryMicroflowQualifiedName

get queryMicroflowQualifiedName(): null | string

Returns null | string

queryOptions

get queryOptions(): rest.QueryOptions
set queryOptions(newValue: rest.QueryOptions): void

In version 9.17.0: introduced

Returns rest.QueryOptions
In version 9.17.0: introduced

Parameters
- newValue: rest.QueryOptions
Returns void

readMode

get readMode(): rest.ReadMode
set readMode(newValue: rest.ReadMode): void

In version 9.14.0: introduced

Returns rest.ReadMode
In version 9.14.0: introduced

Parameters
- newValue: rest.ReadMode
Returns void

summary

get summary(): string
set summary(newValue: string): void

In version 8.0.0: introduced

Returns string
In version 8.0.0: introduced

Parameters
- newValue: string
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Inherited from webservices.PublishedResource.unit
Returns ModelUnit<IAbstractModel>

updatable

get updatable(): boolean
set updatable(newValue: boolean): void

In version 9.11.0: deleted In version 9.4.0: introduced

Returns boolean
In version 9.11.0: deleted In version 9.4.0: introduced

Parameters
- newValue: boolean
Returns void

updateMicroflow

get updateMicroflow(): null | IMicroflow
set updateMicroflow(newValue: null | IMicroflow): void

In version 9.11.0: deleted In version 9.9.0: introduced

Returns null | IMicroflow
In version 9.11.0: deleted In version 9.9.0: introduced

Parameters
- newValue: null | IMicroflow
Returns void

updateMicroflowQualifiedName

get updateMicroflowQualifiedName(): null | string

Returns null | string

updateMode

get updateMode(): rest.ChangeMode
set updateMode(newValue: rest.ChangeMode): void

In version 9.11.0: introduced

Returns rest.ChangeMode
In version 9.11.0: introduced

Parameters
- newValue: rest.ChangeMode
Returns void

usePaging

get usePaging(): boolean
set usePaging(newValue: boolean): void

Returns boolean
Parameters
- newValue: boolean
Returns void

Methods

allProperties

allProperties(): AbstractProperty<any, any>[]

Inherited from PublishedResource.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): PublishedRestResource

Inherited from PublishedResource.asLoaded
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
- If invoked without callback, it checks whether the properties are available or it will throw;
- If invoked with callback, it will load the data from the server if needed, and then invoke the callback.
Returns PublishedRestResource

deepCopy

deepCopy(targetModel: IAbstractModel): PublishedRestResource

Inherited from PublishedResource.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns PublishedRestResource

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }

Inherited from PublishedResource.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }
- copy: Element<IAbstractModel>
- idMap: IMap<Structure<IAbstractModel, null | IContainer>>

delete

delete(): void

Inherited from PublishedResource.delete

Deletes this element from the model.

Returns void

detach

detach(): PublishedRestResource

Inherited from PublishedResource.detach

Detaches this element from the model, so that it can be attached in a different place.

Returns PublishedRestResource

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Inherited from PublishedResource.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from PublishedResource.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: (elem: PublishedRestResource) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<PublishedRestResource>

Inherited from PublishedResource.load
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
- If invoked without callback, it checks whether the properties are available or it will throw;
- If invoked with callback, it will load the data from the server if needed, and then invoke the callback.
Parameters
- callback: (elem: PublishedRestResource) => void
  - - (elem: PublishedRestResource): void
    - Parameters
      - elem: PublishedRestResource
      Returns void
- Optional forceRefresh: boolean
Returns void
Inherited from PublishedResource.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<PublishedRestResource>

loadedProperties

loadedProperties(): AbstractProperty<any, any>[]

Inherited from PublishedResource.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

publicProperties(): AbstractProperty<any, any>[]

Inherited from PublishedResource.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Inherited from PublishedResource.toJSON

Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

Returns IStructureJSON

traverse

traverse(visit: (structure: IStructure) => void): void

Inherited from PublishedResource.traverse

Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: (structure: IStructure) => T): null | T

Inherited from PublishedResource.traverseFind

Traverses this structure, returning immediately when visit returns something other than null.

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

traversePublicParts(visit: (structure: IStructure) => void): void

Inherited from PublishedResource.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): PublishedRestResource

Creates and returns a new PublishedRestResource instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

Parameters
- model: IModel
Returns PublishedRestResource

Static createIn

createIn(container: PublishedODataService): PublishedRestResource

Creates and returns a new PublishedRestResource instance in the SDK and on the server. The new PublishedRestResource will be automatically stored in the 'resources' property of the parent PublishedODataService element passed as argument.

Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 10.3.0

Parameters
- container: PublishedODataService
Returns PublishedRestResource

Generated using TypeDoc