ISitePagesAssignedToUser Method
|
Retrieves a collection of
Pages assigned to a specific
User, in a paginated fashion.
Namespace: Ingeniux.CMSAssembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxIEnumerable<IPage> PagesAssignedToUser(
IUser user,
out int count,
bool includeGroups = false,
int pageSize = -1,
int startIndex = -1
)
Function PagesAssignedToUser (
user As IUser,
<OutAttribute> ByRef count As Integer,
Optional includeGroups As Boolean = false,
Optional pageSize As Integer = -1,
Optional startIndex As Integer = -1
) As IEnumerable(Of IPage)
IEnumerable<IPage^>^ PagesAssignedToUser(
IUser^ user,
[OutAttribute] int% count,
bool includeGroups = false,
int pageSize = -1,
int startIndex = -1
)
abstract PagesAssignedToUser :
user : IUser *
count : int byref *
?includeGroups : bool *
?pageSize : int *
?startIndex : int
(* Defaults:
let _includeGroups = defaultArg includeGroups false
let _pageSize = defaultArg pageSize -1
let _startIndex = defaultArg startIndex -1
*)
-> IEnumerable<IPage> Parameters
- user IUser
- The User that Pages are assigned to
- count Int32
- Outputs total count of entries
- includeGroups Boolean (Optional)
- Whether to include Pages that are assigned to the Groups the
User belongs to
- pageSize Int32 (Optional)
- Number of entries to return. If not provided, returns all entries.
- startIndex Int32 (Optional)
- Starting index of entries. If not provided, starts from the first entry.
Return Value
IEnumerableIPageCollection of
Pages assigned to the specified
User
Remarks
When the "user" parameter value is null, returns empty collection, with "count" parameter output 0.
See Also