Class UserDefinedFunction

Used to read, replace, or delete a specified User Definied Function by id.

see: UserDefinedFunction to create, upsert, query, read all User Defined Functions.

Hierarchy

UserDefinedFunction

Index

Properties

container
id

Accessors

url

Methods

Properties

container

container: Container

The parent Container.

id

id: string

The id of the given UserDefinedFunction.

Accessors

url

get url(): string

- Defined in client/UserDefinedFunction/UserDefinedFunction.ts:23
Returns a reference URL to the resource. Used for linking in Permissions.

Returns string

Methods

delete

delete(options?: RequestOptions): Promise<UserDefinedFunctionResponse>

- Defined in client/UserDefinedFunction/UserDefinedFunction.ts:89
Delete the given {@link UserDefined}.

Parameters
- Optional options: RequestOptions
Returns Promise<UserDefinedFunctionResponse>

read

read(options?: RequestOptions): Promise<UserDefinedFunctionResponse>

- Defined in client/UserDefinedFunction/UserDefinedFunction.ts:41
Read the UserDefinedFunctionDefinition for the given UserDefinedFunction.

Parameters
- Optional options: RequestOptions
Returns Promise<UserDefinedFunctionResponse>

replace

replace(body: UserDefinedFunctionDefinition, options?: RequestOptions): Promise<UserDefinedFunctionResponse>

- Defined in client/UserDefinedFunction/UserDefinedFunction.ts:59
Replace the given UserDefinedFunction with the specified UserDefinedFunctionDefinition.

Parameters
- body: UserDefinedFunctionDefinition
  
  The specified UserDefinedFunctionDefinition.
- Optional options: RequestOptions
Returns Promise<UserDefinedFunctionResponse>

Generated using TypeDoc