Click or drag to resize

PFRelation_Group Methods

The PFRelation_Group type exposes the following members.

Methods
  NameDescription
Public methodAdd
Creates a new group instance, not yet persisted.
Public methodEnsureGroup
Ensures that a group with the specified name exists. If the group did not exist, it is returned not yet persisted.
Public methodGet(Guid)
Gets an object by its GUID.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(PFQuery)
Gets children objects by a given query.

Note: the query cannot contain any group or aggregation.

(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(PFQueryFilter)
Gets objects using multiple filters (separated by an AND operator).
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(String, Object)
Gets all objects with a specific value.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(PFQueryFilter, PFQueryOrder)
Gets objects using a given filter and a given order.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(String, PFQueryFilterOperator, Object)
Gets all objects with a specific value.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(String, Object, String)
Gets all objects with a specific value, ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(String, PFQueryFilterOperator, Object, String)
Gets all objects with a specific value, ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(String, Object, String, Boolean)
Gets all objects with a specific value, ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGet(String, PFQueryFilterOperator, Object, String, Boolean)
Gets all objects with a specific value, ordered by a given column.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetAll
Gets all objects of this relation (filtered by RLS).
(Overrides PFRelation_BaseObjectParentType, ChildTypeGetAll(Boolean, Boolean).)
Public methodGetByApplicationContext
Gets the direct children groups (AR type - roles) of an application context.
Public methodGetByGroup
Gets aggregated/grouped objects by a given query.

Note: the query must contain at least one group or aggregation.

(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetByGuid
Gets an object by its GUID.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetByGuids(ListGuid)
Gets objects by their GUIDs. This is more optimized than calling GetByGuid multiple times.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetByGuids(Guid)
Gets objects by their GUIDs.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetById(Int64)
Gets a group by its id. If not found on application, will try on parent site. Use cache.
(Overrides PFRelation_BaseObjectParentType, ChildTypeGetById(Int64).)
Public methodGetById(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.)
Public methodGetById(Int64, Boolean)
Gets a group by its id. If not found on application, will try on parent site.
(Overrides PFRelation_BaseObjectParentType, ChildTypeGetById(Int64, Boolean).)
Public methodGetByIds(IEnumerableInt64)
Gets objects by their IDs.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetByIds(Int64)
Gets objects by their IDs. This is more optimized than calling GetById multiple times.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetByName
Gets a group by its name. Use cache.
Public methodGetByRole
Gets a group by role guid. Use cache.
Public methodGetByText
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.
Public methodGetChildrenType
Gets the type of objects available in this relation.
(Inherited from PFRelation.)
Public methodGetCount
Gets the count of objects with a global COUNT (with RLS).
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetCount(PFQueryNode)
Gets the count of objects with a global COUNT (with RLS).
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
Public methodGetGroupsContainingCurrentUser(Guid)
Gets the list of groups containing the current user.
Public methodGetGroupsContainingCurrentUser(Int64)
Gets the list of groups containing the current user.
Public methodGetGroupsContainingUser(PFUser, Guid)
Gets the list of groups containing the specified user.
Public methodGetGroupsContainingUser(PFUser, Int64)
Gets the list of groups containing the specified user.
Public methodGetObjectRelationName
Gets the name of the property in parent corresponding to this instance.
(Inherited from PFRelation.)
Public methodGetObjects
Gets children objects by a given query.

Note: the query cannot contain any group or aggregation.

(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetOne(PFQuery)
Gets the first object returned by a given query.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetOne(String, Object)
Gets the first object with a specific value.
(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetOrderBy
Gets all available objects ordered by a given column.

Note: this method does not use cache.

(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodGetRolesContainingCurrentUser
Gets the list of groups containing the current user.
Public methodGetRolesContainingUser
Gets the list of groups containing the specified user.
Public methodIsDeleted
Checks if an object is deleted or not. If deleted, will also return suppression information.

If this object is not available because of RLS, this method will always return false.

(Inherited from PFRelation_BaseObjectParentType, ChildType.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodCastToListTOverloaded.
Casts an enumerable to a strongly typed List.
(Defined by Utils_Linq.)
Public Extension MethodCastToListT(FuncObject, T)Overloaded.
Casts an enumerable to a strongly typed List.
(Defined by Utils_Linq.)
Public Extension MethodDistinctByPFGroup, TIdentity
Returns distinct elements from a sequence by using a specified predicate to compare values.
(Defined by Utils_Linq.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodForEachPFGroup
Performs the specified action on each element of the System.Collections.Generic.IEnumerable/T/.
(Defined by Utils_Linq.)
Public Extension MethodGetStringOverloaded.
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodGetStringPFGroup(String)Overloaded.
Creates a string with all values in the List, separated by a string.

Uses ToString to convert objects.

(Defined by Utils_Linq.)
Public Extension MethodGetStringPFGroup(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.)
Public Extension MethodIsEmptyPFGroup
Checks if a list is empty.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodIsNotEmptyPFGroup
Checks if a list is not empty.
(Defined by Utils_Linq.)
Public Extension MethodIsNullOrEmptyPFGroup
Checks if a list is null or empty.
(Defined by Utils_Linq.)
Public Extension MethodNotNullPFGroup
Filters a collection of values, excluding null values.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
See Also