PFSiteService Class

Packflow data service allowing retrieving informations about the site, its applications, its organisation, etc.

Inheritance Hierarchy

SystemObject
Packflow.Interface.ServicesPFService
Packflow.Interface.ServicesPFSiteService

Namespace: Packflow.Interface.Services
Assembly: MicaSystems.Packflow.Interface (in MicaSystems.Packflow.Interface.dll) Version: 1.0.0.0 (2.0.0.223)

Syntax

Copy

[ServiceContractAttribute]
[AspNetCompatibilityRequirementsAttribute(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
public class PFSiteService : PFService

The PFSiteService type exposes the following members.

Constructors

	Name	Description
	PFSiteService	Initializes a new instance of the PFSiteService class.
	PFSiteService(HubCallerContext)	Initializes a new instance of the PFSiteService class.

Top

Properties

	Name	Description
	SessionKey	Gets the session key (from request parameters). (Inherited from PFService.)

Top

Methods

	Name	Description
	CheckSessionSite	Checks if a session site is currently loaded for the web service's connection.
	ExecuteOperation	Executes an service operation, providing a Packflow site, step object and exception handling. (Inherited from PFService.)
	GetApplicationById	Gets an application by its id.
	GetApplicationByName	Gets an application by its name.
	GetApplicationContextGroups	Gets the groups of an application context.
	GetApplicationContextGroups2	Gets the groups of an application context.
	GetApplicationContexts	Gets the contexts of an application.
	GetApplicationContexts2	Gets the contexts of an application.
	GetApplicationGroupById	Gets an application group by its id.
	GetApplicationGroupById2	Gets an application group by its id.
	GetApplicationGroupByName	Gets an application group by its name.
	GetApplicationGroupByName2	Gets an application group by its name.
	GetApplicationGroups	Gets application groups.
	GetApplicationGroups2	Gets application groups.
	GetApplicationGroupsByText	Gets application groups using a filter (name of display name).
	GetApplicationGroupsByText2	Gets application groups using a filter (name of display name).
	GetApplications	Gets current site's applications.
	GetContentTypesByApplicationId	Gets all content-types of an application.
	GetContentTypesByApplicationName	Gets all content-types of an application.
	GetSite	Gets current site's information.
	GetSite(String, Boolean)	Gets the current Packflow site. (Inherited from PFService.)
	GetSiteGroupById	Gets a site group by its id.
	GetSiteGroupByName	Gets a site group by its name.
	GetSiteGroups	Gets current site's groups.
	GetSiteGroupsByQuery	Gets site groups by a query.
	GetSiteGroupsByText	Gets current site's groups using a filter.
	GetUserById	Gets a user by its id.
	GetUserByLogin	Gets a user by its login name.
	GetUsers	Gets current site's users.
	GetUsersByQuery	Gets users by a query.
	GetUsersByText	Gets current site's users using a filter.
	GetUsersWithAccessToApplicationById	Gets users with access to an application.
	GetUsersWithAccessToApplicationByName	Gets users with access to an application.
	HandleException	Handles an exception for an operation, tries to log and rethrow. (Inherited from PFService.)
	ReleaseSessionSite	Releases the current session site.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetUserByIdentity	Gets a user by its login name.
	UpdateApplicationGroupMembership	Updates users and groups of an application group.

Top

Extension Methods

	Name	Description
	AsT	Casts an object to another type. Returns default(T) if the object is null. (Defined by Utils_Other.)
	EqualsAll	Checks that this object is equal to every object in parameters. (Defined by Utils_Other.)
	EqualsAny	Checks that this object is equal to at least one of the parameters. (Defined by Utils_Other.)
	GetString	Converts an object to String using ToString() method, else returns String.Empty. (Defined by Utils_Other.)
	IsGenericList	Overloaded. Checks if this object is a System.Collections.Generic.List. (Defined by Utils_Linq.)
	IsGenericList(Type)	Overloaded. Checks if this object is a System.Collections.Generic.List using type as T. (Defined by Utils_Linq.)
	Serialize	Overloaded. Serializes an object into an XML document. (Defined by Utils_Xml.)
	Serialize(String)	Overloaded. Serializes an object into an XML document. (Defined by Utils_Xml.)
	SerializeJson	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)
	SerializeJson(ListType)	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)
	SerializeJson(DataContractJsonSerializerSettings)	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)

Top

Reference

Packflow.Interface.Services Namespace