Skip to content

IAdmReportCategory

The IAdmReportCategory is the base interface for all interfaces that represent report categories.

Inheritance: The IAdmReportCategory interface inherits from the IAdmGroup interface.

Methods

Properties

  • Property

  • Description

  • CategoryName

  • Gets or sets a name of the report category.

  • CategoryId

  • Gets the unique immutable identifier of the report category.

  • Color

  • Gets or sets a color of the report category.

Details

GetAssignedObjects()

Returns objects of the given type assigned to the category.

IAdmTop[] GetAssignedObjects(ADM_REPORTCATEGORYASSIGNEETYPE_ENUM assigneeType)

Parameters

The assigneeType parameter specifies the type of objects to return.


GetAssignedObjectIDs()

Returns unique identifiers of objects of the given type assigned to the category.

String[] GetAssignedObjectIDs(ADM_REPORTCATEGORYASSIGNEETYPE_ENUM assigneeType)

Parameters

The assigneeType parameter specifies the type of objects for which to return unique identifiers.


GetAssignedObjectGuids()

Returns GUIDs of objects of the given type assigned to the category.

String[] GetAssignedObjectGuids(ADM_REPORTCATEGORYASSIGNEETYPE_ENUM assigneeType)

Parameters

The assigneeType parameter specifies the type of objects for which to return GUIDs.


GetAssignedObjectCount()

Returns the number of objects of the given type assigned to the category.

Int32 GetAssignedObjectCount(ADM_REPORTCATEGORYASSIGNEETYPE_ENUM assigneeType)

Parameters

The assigneeType parameter specifies the type of objects to count.


CategoryName

Gets or sets a name of the report category.

  • Type:
  • String
  • Access:
  • Read/Write

CategoryId

Gets the unique immutable identifier of the report category.

  • Type:
  • String
  • Access:
  • Read-only

Remarks

The identifier does not change if you backup and restore Adaxes service configuration.


Color

Gets or sets a color of the report category.

  • Type:
  • Int32
  • Access:
  • Read/Write

Remarks

The color is specified as an Int32 value with AARRGGBB byte-ordering, where each byte represents a color component. The most significant byte, represented by AA, is the alpha component value. This byte must be always 0. The bytes represented by RR, GG, and BB are the red, green, and blue color components respectively.

Examples

  • Red - 255
  • Yellow - 65535
  • Magenta - 16711935
  • Set the property value to -1 to use the default color.

Requirements

Minimum required version: 2018.1

See also