Galleries In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:32:45 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:32:45

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

Events

Events.AfterCreate

Handler

void GalleryAfterCreateEventHandler([[GalleryAfterCreateEventArgs In-Process API Event Argument|GalleryAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void GalleryAfterDeleteEventHandler([[GalleryAfterDeleteEventArgs In-Process API Event Argument|GalleryAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void GalleryAfterUpdateEventHandler([[GalleryAfterUpdateEventArgs In-Process API Event Argument|GalleryAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void GalleryBeforeCreateEventHandler([[GalleryBeforeCreateEventArgs In-Process API Event Argument|GalleryBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void GalleryBeforeDeleteEventHandler([[GalleryBeforeDeleteEventArgs In-Process API Event Argument|GalleryBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void GalleryBeforeUpdateEventHandler([[GalleryBeforeUpdateEventArgs In-Process API Event Argument|GalleryBeforeUpdateEventArgs]] e);

Events.Render

Handler

void GalleryRenderEventHandler([[GalleryRenderEventArgs In-Process API Event Argument|GalleryRenderEventArgs]] e);

Properties

Name	Type	Description
ApplicationTypeId	`Guid`	Galleries application type identifier
ContentTypeId	`Guid`	Galleries content type identifier
TotalLicensedRemaining	`int`

Methods

Gallery Create(int groupId, string name, GalleriesCreateOptions options = null);

Creates a Gallery

Parameters

Name	Type	Description	Required
groupId	`int`	Group Id	Required
name	`string`	Name	Required
options	`[[GalleriesCreateOptions In-Process API Supplementary Type\|GalleriesCreateOptions]]`	Optional parameter names are: Key, Description, Enabled, ExtendedAttributes	Optional

Return Type

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

AdditionalInfo Delete(int id);

Deletes a Gallery

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Gallery Id	Required

Return Type

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

Gallery Get(Guid applicationId);

Gets a Gallery

Parameters

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

Return Type

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

Gallery Get(GalleriesGetOptions options);

Gets a Gallery

Parameters

Name	Type	Description	Required	Default	Options
options	`[[GalleriesGetOptions In-Process API Supplementary Type\|GalleriesGetOptions]]`	Optional parameter names are: Id, Key, GroupId	Required

Return Type

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

PagedList<Gallery> List(GalleriesListOptions options = null);

Lists Galleries

Parameters

Name	Type	Description	Required	Default	Options
options	`[[GalleriesListOptions In-Process API Supplementary Type\|GalleriesListOptions]]`	Optional parameter names are: GroupId, IncludeSubGroups, ApplicationIds, PageIndex, PageSize, UserId, PermissionId, SortBy, SortOrder. If left unspecified, sorting defaults to SortOrder Ascending.	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[Gallery In-Process API Supplementary Type|Gallery]]>

Gallery Update(int id, GalleriesUpdateOptions options);

Updates a Gallery

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Gallery Id	Required
options	`[[GalleriesUpdateOptions In-Process API Supplementary Type\|GalleriesUpdateOptions]]`	Optional parameter names are: GroupId, Name, Key, Description, Enabled, ExtendedAttributes	Required

Return Type

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