Container In-Process API Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:33:49 GMT

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

Container is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

class Container
{
	string AvatarUrl { get;  }
	Guid ContainerId { get;  }
	Guid ContainerTypeId { get;  }
	bool IsEnabled { get;  }
	[[Container In-Process API Supplementary Type|Container]] ParentContainer { get;  }
	string Url { get;  }
	string HtmlName(string target);
}

Properties

Name	Type	Description
AvatarUrl	`string`	The Url to the container’s avatar.
ContainerId	`Guid`	A Guid uniquely identifying the container.
ContainerTypeId	`Guid`	A Guid identifying the type of container. All container of the same type (i.e. group) will have the same value here.
IsEnabled	`bool`	A flag representing whether the container is enabled.
ParentContainer	`[[Container In-Process API Supplementary Type\|Container]]`
Url	`string`	A Url to the container on the site.

Methods

string HtmlName(string target);

This method should return the Html encoded name of the container. Possible values for “target” are “Web”, “Email”, or “raw”. When “raw” is specified as the target, the name should not be encoded.

Parameters

Name	Type	Description	Required	Default	Options
target	`string`	Target	Required

Return Type

string