Applications In-Process API Service

Former Member — Thu, 02 Jun 2022 15:15:21 GMT

Current Revision posted to API Documentation by Former Member on 06/02/2022 15:15:21

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IApplications>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void ApplicationAfterCreateEventHandler([[ApplicationAfterCreateEventArgs In-Process API Event Argument|ApplicationAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ApplicationAfterDeleteEventHandler([[ApplicationAfterDeleteEventArgs In-Process API Event Argument|ApplicationAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ApplicationAfterUpdateEventHandler([[ApplicationAfterUpdateEventArgs In-Process API Event Argument|ApplicationAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ApplicationBeforeCreateEventHandler([[ApplicationBeforeCreateEventArgs In-Process API Event Argument|ApplicationBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ApplicationBeforeDeleteEventHandler([[ApplicationBeforeDeleteEventArgs In-Process API Event Argument|ApplicationBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ApplicationBeforeUpdateEventHandler([[ApplicationBeforeUpdateEventArgs In-Process API Event Argument|ApplicationBeforeUpdateEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	Applications data type identifier

Methods

Application Get(Guid applicationId);

Retrieve a specific application

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required

Return Type

[[Application In-Process API Supplementary Type|Application]]

Application Get(Guid applicationId, Guid applicationTypeId);

Retrieve a specific application

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application type Id	Required

Return Type

[[Application In-Process API Supplementary Type|Application]]

ApiList<Application> List(Guid containerTypeId, Guid containerId);

Retrieves the first 50 applications within a container.

Parameters

Name	Type	Description	Required	Default	Options
containerTypeId	`Guid`	Container Type Id	Required
containerId	`Guid`	Container Id	Required

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[Application In-Process API Supplementary Type|Application]]>

ApiList<Application> List(Guid containerTypeId, Guid containerId, ApplicationListOptions options);

Retrieves the first 50 applications within a container.

Parameters

Name	Type	Description	Required
containerTypeId	`Guid`	Container Type Id	Required
containerId	`Guid`	Container Id	Required
options	`[[ApplicationListOptions In-Process API Supplementary Type\|ApplicationListOptions]]`	Options	Required

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[Application In-Process API Supplementary Type|Application]]>

ApiList<Application> Search(Guid containerTypeId, Guid containerId, string searchText);

Retrieves applications within a container via searching.

Parameters

Name	Type	Description	Required
containerTypeId	`Guid`	Container Type Id	Required
containerId	`Guid`	Container Id	Required
searchText	`string`	Search Text	Required

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[Application In-Process API Supplementary Type|Application]]>