UserGroupSelectionServices Class

Ingeniux CMS Web Services API

Provides the ability to retrieve a collection of users and groups.

Inheritance Hierarchy

SystemObject
  CMSServicesBase
    CMSContentServiceBase
      IngeniuxCMServiceUserGroupSelectionServices

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

[ServiceBehaviorAttribute(IncludeExceptionDetailInFaults = true)]
[AspNetCompatibilityRequirementsAttribute(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
public class UserGroupSelectionServices : CMSContentServiceBase

<ServiceBehaviorAttribute(IncludeExceptionDetailInFaults := true)>
<AspNetCompatibilityRequirementsAttribute(RequirementsMode := AspNetCompatibilityRequirementsMode.Allowed)>
Public Class UserGroupSelectionServices
	Inherits CMSContentServiceBase

[ServiceBehaviorAttribute(IncludeExceptionDetailInFaults = true)]
[AspNetCompatibilityRequirementsAttribute(RequirementsMode = AspNetCompatibilityRequirementsMode::Allowed)]
public ref class UserGroupSelectionServices : public CMSContentServiceBase

[<ServiceBehaviorAttribute(IncludeExceptionDetailInFaults = true)>]
[<AspNetCompatibilityRequirementsAttribute(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)>]
type UserGroupSelectionServices =  
    class
        inherit CMSContentServiceBase
    end

The UserGroupSelectionServices type exposes the following members.

Constructors

	Name	Description
	UserGroupSelectionServices

Top

Methods

	Name	Description
	GetUserGroupsForPages	Retrieves the collection of Users or User Groups based on the given Pages and Transition This operations is mainly used for retrieving the list of Users or Group for Page assignment, inside or outside of Workflow transition. For User Groups retrieval scenario: If Page is not in Workflow, it can be assigned to any User Groups, therefore all User Groups are returned. If Page is in Workflow, and the assignment is happening through Transition (trantionId provided), then the Transition's Target Group is returned. If Page is in Workflow, and the assignment is not through Transition (transitionId not provided), then the Current Group of the Workflow State is returned. For Users retrieval scenario: If Page is not in Workflow, it can be assigned to any Users, therefore all Users are returned. If Page is in Workflow, and the assignment is happening through Transition (transitionId provided), then the Users that belong to the Transition's Target Group are returned. If Page is in Workflow, and the assignment is not through Transition (transitionId not provided), then the Users that belong to the Current Group of the Workflow State are returned. The result is combination of all Users/Users Groups each Page allows.
	GetUserGroupsForWorkflowAdd	Retrieves the collection of Users or User Groups available to assign the Page to, when Page is added to Workflow.
	GetUsersAndGroups	Retrieves collection of Users and UserGroups.

Top

Reference

IngeniuxCMService Namespace