PFRelation_Group Methods |
The PFRelation_Group type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Add |
Creates a new group instance, not yet persisted.
|
| EnsureGroup |
Ensures that a group with the specified name exists.
If the group did not exist, it is returned not yet persisted.
|
| Get(Guid) |
Gets an object by its GUID.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| Get(PFQuery) |
Gets children objects by a given query.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)Note: the query cannot contain any group or aggregation. |
| Get(PFQueryFilter) |
Gets objects using multiple filters (separated by an AND operator).
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| Get(String, Object) |
Gets all objects with a specific value.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| Get(PFQueryFilter, PFQueryOrder) |
Gets objects using a given filter and a given order.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| Get(String, PFQueryFilterOperator, Object) |
Gets all objects with a specific value.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| Get(String, Object, String) |
Gets all objects with a specific value, ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| Get(String, PFQueryFilterOperator, Object, String) |
Gets all objects with a specific value, ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| Get(String, Object, String, Boolean) |
Gets all objects with a specific value, ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| Get(String, PFQueryFilterOperator, Object, String, Boolean) |
Gets all objects with a specific value, ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetAll |
Gets all objects of this relation (filtered by RLS).
(Overrides PFRelation_BaseObjectParentType, ChildTypeGetAll(Boolean, Boolean).) |
| GetByApplicationContext |
Gets the direct children groups (AR type - roles) of an application context.
|
| GetByGroup |
Gets aggregated/grouped objects by a given query.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)Note: the query must contain at least one group or aggregation. |
| GetByGuid |
Gets an object by its GUID.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetByGuids(ListGuid) |
Gets objects by their GUIDs.
This is more optimized than calling GetByGuid multiple times.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetByGuids(Guid) |
Gets objects by their GUIDs.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetById(Int64) |
Gets a group by its id. If not found on application, will try on parent site. Use cache.
(Overrides PFRelation_BaseObjectParentType, ChildTypeGetById(Int64).) |
| GetById(Int64, PFQueryResultsScope) |
Gets a child object by its ID, with a specified scope.
This method DOES NOT use the cache.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetById(Int64, Boolean) |
Gets a group by its id. If not found on application, will try on parent site.
(Overrides PFRelation_BaseObjectParentType, ChildTypeGetById(Int64, Boolean).) |
| GetByIds(IEnumerableInt64) |
Gets objects by their IDs.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetByIds(Int64) |
Gets objects by their IDs.
This is more optimized than calling GetById multiple times.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetByName |
Gets a group by its name. Use cache.
|
| GetByRole |
Gets a group by role guid. Use cache.
|
| GetByText |
Gets groups which contain this text (in Name or Display name).
Will use cache if available.
Returns all groups if filter is null or empty.
|
| GetChildrenType |
Gets the type of objects available in this relation.
(Inherited from PFRelation.) |
| GetCount |
Gets the count of objects with a global COUNT (with RLS).
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetCount(PFQueryNode) |
Gets the count of objects with a global COUNT (with RLS).
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
|
| GetGroupsContainingCurrentUser(Guid) |
Gets the list of groups containing the current user.
|
| GetGroupsContainingCurrentUser(Int64) |
Gets the list of groups containing the current user.
|
| GetGroupsContainingUser(PFUser, Guid) |
Gets the list of groups containing the specified user.
|
| GetGroupsContainingUser(PFUser, Int64) |
Gets the list of groups containing the specified user.
|
| GetObjectRelationName |
Gets the name of the property in parent corresponding to this instance.
(Inherited from PFRelation.) |
| GetObjects |
Gets children objects by a given query.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)Note: the query cannot contain any group or aggregation. |
| GetOne(PFQuery) |
Gets the first object returned by a given query.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetOne(String, Object) |
Gets the first object with a specific value.
(Inherited from PFRelation_BaseObjectParentType, ChildType.) |
| GetOrderBy |
Gets all available objects ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)Note: this method does not use cache. |
| GetRolesContainingCurrentUser |
Gets the list of groups containing the current user.
|
| GetRolesContainingUser |
Gets the list of groups containing the specified user.
|
| IsDeleted |
Checks if an object is deleted or not. If deleted, will also return suppression information.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)If this object is not available because of RLS, this method will always return false. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| CastToListT | Overloaded.
Casts an enumerable to a strongly typed List.
(Defined by Utils_Linq.) |
| CastToListT(FuncObject, T) | Overloaded.
Casts an enumerable to a strongly typed List.
(Defined by Utils_Linq.) |
| DistinctByPFGroup, TIdentity |
Returns distinct elements from a sequence by using a specified predicate to compare values.
(Defined by Utils_Linq.) |
| 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.) |
| ForEachPFGroup |
Performs the specified action on each element of the System.Collections.Generic.IEnumerable/T/.
(Defined by Utils_Linq.) |
| GetString | Overloaded.
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| GetStringPFGroup(String) | Overloaded.
Creates a string with all values in the List, separated by a string.
(Defined by Utils_Linq.)Uses ToString to convert objects. |
| GetStringPFGroup(String, FuncPFGroup, String) | Overloaded.
Creates a string with all values (converted using a function) in the List, separated by a string.
(Defined by Utils_Linq.) |
| IsEmptyPFGroup |
Checks if a list is empty.
(Defined by Utils_Linq.) |
| 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.) |
| IsNotEmptyPFGroup |
Checks if a list is not empty.
(Defined by Utils_Linq.) |
| IsNullOrEmptyPFGroup |
Checks if a list is null or empty.
(Defined by Utils_Linq.) |
| NotNullPFGroup |
Filters a collection of values, excluding null values.
(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.) |
See Also