Class ChangelogControllerGetLatestRemoteMethod

Hierarchy

OpenApiRemoteMethod<
    ChangelogControllerGetLatestResponse,
    ChangelogControllerGetLatestParameter,
    void,
>
- ChangelogControllerGetLatestRemoteMethod

Constructors

constructor

new ChangelogControllerGetLatestRemoteMethod(
    http: HttpClient,
    injector: Injector,
    openApiConfigService: OpenApiConfigService,
    metadata?: null | OpenApiMetaData,
    strict?: null | boolean,
    disableSchemaValidation?: null | boolean,
    disableValidation?: null | boolean,
): ChangelogControllerGetLatestRemoteMethod
Parameters
- http: HttpClient
- injector: Injector
- openApiConfigService: OpenApiConfigService
- metadata: null | OpenApiMetaData = null
- strict: null | boolean = null
- disableSchemaValidation: null | boolean = null
- disableValidation: null | boolean = null
Returns ChangelogControllerGetLatestRemoteMethod
Inherited from OpenApiRemoteMethod<ChangelogControllerGetLatestResponse, ChangelogControllerGetLatestParameter, void>.constructor
- Defined in open-api/remote-method/src/lib/open-api.remote-method.ts:103

Properties

`Internal`__id

__id: string = ...

unique internal id

`Protected`_httpRequest

_httpRequest: HttpRequest<ChangelogControllerGetLatestResponse>

`Protected`_initialised

_initialised: boolean = false

`Readonly`destroyed$

destroyed$: undefined | Subject<void> = ...

Emits if the data source is destroyed

`Protected` `Readonly`disableSchemaValidation

disableSchemaValidation: boolean = false

`Protected` `Readonly`disableValidation

disableValidation: boolean = false

executed$

executed$: Subject<ChangelogControllerGetLatestResponse> = ...

executionsInProgress$

executionsInProgress$: CounterSubject = ...

`Readonly`http

http: HttpClient

`Readonly`initialised$

initialised$: undefined | Subject<void> = ...

Emits if the data source is initialised

`Readonly`injector

injector: Injector

`Readonly`interceptors

interceptors: undefined | Set<Subject<any>> = ...

metadata

metadata: HttpRemoteMethodMetadata

timeout

timeout: number = ...

`Static` `Readonly`destroyed$

destroyed$: Subject<BaseDefinition<BaseDefinitionMetadata>> = ...

Emits when a new Definition instance is initialised

`Static` `Readonly`initialised$

initialised$: Subject<BaseDefinition<BaseDefinitionMetadata>> = ...

Emits when a new Definition instance is initialised

`Static` `Readonly`instances

instances: Map<string, BaseDefinition<BaseDefinitionMetadata>> = ...

A map of active Definition instances

Accessors

id

get id(): string
Returns string
Inherited from OpenApiRemoteMethod.id
- Defined in definition/src/lib/definition.ts:87

operation

get operation(): OperationObjectWithMetadata
Returns OperationObjectWithMetadata
Inherited from OpenApiRemoteMethod.operation
- Defined in open-api/remote-method/src/lib/open-api.remote-method.ts:143

Methods

`Protected`_call

_call(
    args?: OpenApiRemoteMethodParameter<
        ChangelogControllerGetLatestParameter,
        void,
    >,
): Promise<ChangelogControllerGetLatestResponse>
Parameters
- args: OpenApiRemoteMethodParameter<ChangelogControllerGetLatestParameter, void> = {}
Returns Promise<ChangelogControllerGetLatestResponse>
Inherited from OpenApiRemoteMethod._call
- Defined in open-api/remote-method/src/lib/open-api.remote-method.ts:211

_callWithResponse

_callWithResponse(
    args?: OpenApiRemoteMethodParameter<
        ChangelogControllerGetLatestParameter,
        void,
    >,
): Promise<HttpResponse<ChangelogControllerGetLatestResponse>>
Parameters
- args: OpenApiRemoteMethodParameter<ChangelogControllerGetLatestParameter, void> = {}
Returns Promise<HttpResponse<ChangelogControllerGetLatestResponse>>
Inherited from OpenApiRemoteMethod._callWithResponse
- Defined in open-api/remote-method/src/lib/open-api.remote-method.ts:163

applyMetadata

applyMetadata(partialMetadata: Partial<HttpRemoteMethodMetadata>): void
Parameters
- partialMetadata: Partial<HttpRemoteMethodMetadata>
Returns void
Inherited from OpenApiRemoteMethod.applyMetadata
- Defined in definition/src/lib/definition.ts:111

buildHttpHeaders

buildHttpHeaders(
operationParameters: ParameterObject[],
parameters?: ChangelogControllerGetLatestParameter,
): HttpHeaders
Parameters
- operationParameters: ParameterObject[]
- Optionalparameters: ChangelogControllerGetLatestParameter
Returns HttpHeaders
Inherited from OpenApiRemoteMethod.buildHttpHeaders
- Defined in open-api/src/lib/schema-validation.mixin.ts:293

buildHttpOptions

buildHttpOptions(
    operation: OperationObjectWithMetadata,
    parameters?: ChangelogControllerGetLatestParameter,
    requestBody?: void,
    ignoreUndefined?: boolean,
): HttpRemoteMethodParameter
Converts open api parameters into the corresponding http options to create a http request. The transformation is guided by the openapi definition
Parameters
- operation: OperationObjectWithMetadata
- Optionalparameters: ChangelogControllerGetLatestParameter
- OptionalrequestBody: void
- ignoreUndefined: boolean = true
Returns HttpRemoteMethodParameter
Inherited from OpenApiRemoteMethod.buildHttpOptions
- Defined in open-api/src/lib/schema-validation.mixin.ts:367

buildHttpParams

buildHttpParams(
    operationParameters: ParameterObject[],
    parameters?: ChangelogControllerGetLatestParameter,
    ignoreUndefined?: boolean,
): HttpParams
Parameters
- operationParameters: ParameterObject[]
- Optionalparameters: ChangelogControllerGetLatestParameter
- ignoreUndefined: boolean = true
Returns HttpParams
Inherited from OpenApiRemoteMethod.buildHttpParams
- Defined in open-api/src/lib/schema-validation.mixin.ts:244

buildHttpPathParams

buildHttpPathParams(
operationParameters: ParameterObject[],
parameters?: ChangelogControllerGetLatestParameter,
): Record<string, string>
Parameters
- operationParameters: ParameterObject[]
- Optionalparameters: ChangelogControllerGetLatestParameter
Returns Record<string, string>
Inherited from OpenApiRemoteMethod.buildHttpPathParams
- Defined in open-api/src/lib/schema-validation.mixin.ts:333

buildUrlWithParams

buildUrlWithParams(url: string, pathParams?: any): string
Parameters
- url: string
- OptionalpathParams: any
Returns string
Inherited from OpenApiRemoteMethod.buildUrlWithParams
- Defined in remote-method/http/src/lib/base-http.remote-method.ts:107

call

call(
    parameters: OpenApiRemoteMethodParameter<
        ChangelogControllerGetLatestParameter,
        void,
    >,
): Promise<ChangelogControllerGetLatestResponse>
Parameters
- parameters: OpenApiRemoteMethodParameter<ChangelogControllerGetLatestParameter, void>
Returns Promise<ChangelogControllerGetLatestResponse>
Overrides OpenApiRemoteMethod.call
- Defined in changelog/src/lib/openapi/remote-methods/changelog-controller-get-latest.remote-method.ts:20

callWithResponse

callWithResponse(
    args?: OpenApiRemoteMethodParameter<
        ChangelogControllerGetLatestParameter,
        void,
    >,
): Promise<HttpResponse<ChangelogControllerGetLatestResponse>>
Instead of returning the response body the full response object is returned
Parameters
- args: OpenApiRemoteMethodParameter<ChangelogControllerGetLatestParameter, void> = {}
Returns Promise<HttpResponse<ChangelogControllerGetLatestResponse>>
Inherited from OpenApiRemoteMethod.callWithResponse
- Defined in open-api/remote-method/src/lib/open-api.remote-method.ts:150

destroy

destroy(): void
Returns void
Deprecated
use ngOnDestroy instead
Inherited from OpenApiRemoteMethod.destroy
- Defined in definition/src/lib/definition.ts:118

executed

executed(result: ChangelogControllerGetLatestResponse): void
Parameters
- result: ChangelogControllerGetLatestResponse
Returns void
Inherited from OpenApiRemoteMethod.executed
- Defined in remote-method/src/lib/base.remote-method.ts:86

getMetadata

getMetadata(): null | HttpRemoteMethodMetadata
Returns null | HttpRemoteMethodMetadata
Inherited from OpenApiRemoteMethod.getMetadata
- Defined in definition/src/lib/definition.ts:107

`Protected`getRequestUrl

getRequestUrl(): string
Returns string
Inherited from OpenApiRemoteMethod.getRequestUrl
- Defined in remote-method/http/src/lib/base-http.remote-method.ts:138

init

init(): void
Returns void
Inherited from OpenApiRemoteMethod.init
- Defined in remote-method/http/src/lib/base-http.remote-method.ts:77

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Inherited from OpenApiRemoteMethod.ngOnDestroy
- Defined in definition/src/lib/definition.ts:122

pauseRefresh

pauseRefresh(): void
Returns void
Inherited from OpenApiRemoteMethod.pauseRefresh
- Defined in remote-method/src/lib/base.remote-method.ts:92

refresh

refresh(): void
Returns void
Inherited from OpenApiRemoteMethod.refresh
- Defined in remote-method/src/lib/base.remote-method.ts:100

resumeRefresh

resumeRefresh(): void
Returns void
Inherited from OpenApiRemoteMethod.resumeRefresh
- Defined in remote-method/src/lib/base.remote-method.ts:96

updateRequest

updateRequest(
parameters: Partial<HttpRemoteMethodParameter<any>>,
): HttpRequest<ChangelogControllerGetLatestResponse>
Parameters
- parameters: Partial<HttpRemoteMethodParameter<any>>
Returns HttpRequest<ChangelogControllerGetLatestResponse>
Inherited from OpenApiRemoteMethod.updateRequest
- Defined in remote-method/http/src/lib/base-http.remote-method.ts:93

`Protected`validateParameters

validateParameters(
    operation: OperationObjectWithMetadata,
    parameters?: ChangelogControllerGetLatestParameter,
    strict?: boolean,
): void
Protected
Validates the parameters against the schema specified in the operation object
Parameters
- operation: OperationObjectWithMetadata
- Optionalparameters: ChangelogControllerGetLatestParameter
- strict: boolean = false
Returns void
Inherited from OpenApiRemoteMethod.validateParameters
- Defined in open-api/src/lib/schema-validation.mixin.ts:45

validateRequestBody

validateRequestBody(
    operation: OperationObjectWithMetadata,
    body?: void,
    strict?: boolean,
): void
Parameters
- operation: OperationObjectWithMetadata
- Optionalbody: void
- strict: boolean = false
Returns void
Inherited from OpenApiRemoteMethod.validateRequestBody
- Defined in open-api/src/lib/schema-validation.mixin.ts:189

`Protected`validateResponse

validateResponse(
    operation: OperationObjectWithMetadata,
    response: SchemaValidationResponse<ChangelogControllerGetLatestResponse>,
    strict?: boolean,
): void
Protected
Validates the http response against the schema specified in the operation object
Parameters
- operation: OperationObjectWithMetadata
- response: SchemaValidationResponse<ChangelogControllerGetLatestResponse>
- strict: boolean = false
Returns void
Inherited from OpenApiRemoteMethod.validateResponse
- Defined in open-api/src/lib/schema-validation.mixin.ts:122

validationError

validationError(
    message: string,
    strict: boolean,
    schema?: SchemaObject | ReferenceObject,
    value?: any,
): void
Parameters
- message: string
- strict: boolean
- Optionalschema: SchemaObject | ReferenceObject
- Optionalvalue: any
Returns void
Inherited from OpenApiRemoteMethod.validationError
- Defined in open-api/src/lib/schema-validation.mixin.ts:222

`Static`add

add(definition: BaseDefinition): void
Parameters
- definition: BaseDefinition
Returns void
Inherited from OpenApiRemoteMethod.add
- Defined in definition/src/lib/definition.ts:94

`Static`remove

remove(definition: BaseDefinition): void
Parameters
- definition: BaseDefinition
Returns void
Inherited from OpenApiRemoteMethod.remove
- Defined in definition/src/lib/definition.ts:102

Class ChangelogControllerGetLatestRemoteMethod

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ChangelogControllerGetLatestRemoteMethod

Properties

Internal__id

Protected_httpRequest

Protected_initialised

Readonlydestroyed$

Protected ReadonlydisableSchemaValidation

Protected ReadonlydisableValidation

executed$

executionsInProgress$

Readonlyhttp

Readonlyinitialised$

Readonlyinjector

Readonlyinterceptors

metadata

timeout

Static Readonlydestroyed$

Static Readonlyinitialised$

Static Readonlyinstances

Accessors

id

Returns string

operation

Returns OperationObjectWithMetadata

Methods

Protected_call

Parameters

Returns Promise<ChangelogControllerGetLatestResponse>

_callWithResponse

Parameters

Returns Promise<HttpResponse<ChangelogControllerGetLatestResponse>>

applyMetadata

Parameters

Returns void

buildHttpHeaders

Parameters

Returns HttpHeaders

buildHttpOptions

Parameters

Returns HttpRemoteMethodParameter

buildHttpParams

Parameters

Returns HttpParams

buildHttpPathParams

Parameters

Returns Record<string, string>

buildUrlWithParams

Parameters

Returns string

call

Parameters

Returns Promise<ChangelogControllerGetLatestResponse>

callWithResponse

Parameters

Returns Promise<HttpResponse<ChangelogControllerGetLatestResponse>>

destroy

Returns void

Deprecated

executed

Parameters

Returns void

getMetadata

Returns null | HttpRemoteMethodMetadata

ProtectedgetRequestUrl

Returns string

init

Returns void

ngOnDestroy

Returns void

pauseRefresh

`Internal`__id

`Protected`_httpRequest

`Protected`_initialised

`Readonly`destroyed$

`Protected` `Readonly`disableSchemaValidation

`Protected` `Readonly`disableValidation

`Readonly`http

`Readonly`initialised$

`Readonly`injector

`Readonly`interceptors

`Static` `Readonly`destroyed$

`Static` `Readonly`initialised$

`Static` `Readonly`instances

`Protected`_call

`Protected`getRequestUrl

`Protected`validateParameters

`Protected`validateResponse

`Static`add

`Static`remove