C# Class Microsoft.Legal.MatterCenter.Jobs.SPList

This file provide methods to get/update information from/in SP lists

Show file Open project: Microsoft/mattercenter

Public Methods

Method	Description
BreakItemPermission ( ClientContext clientContext, string listName, int listItemId, bool isCopyRoleAssignment ) : bool	Validates and breaks the item level permission for the specified list item under the list/library.
BreakPermission ( ClientContext clientContext, string libraryName, bool isCopyRoleAssignment ) : bool	Breaks the permissions of the list.
CheckUserSecurity ( ClientContext clientContext, Matter matter, IList userIds ) : Principal>>.List
FetchUserPermissionForLibrary ( ClientContext clientContext, string libraryname ) : IEnumerable
GetData ( ClientContext clientContext, string listName, string camlQuery = null ) : ListItemCollection	Gets the list items of specified list based on CAML query.
GetListProperties ( ClientContext clientContext, string libraryName ) : PropertyValues
GetLoggedInUserDetails ( ClientContext clientContext ) : Users	This method will return the user object who has currently logged into the system
GetMatterAssignedUsersEmail ( ClientContext clientContext, Matter matter ) : string	Converts the project users emails in a form that can be stamped to library.
GetMatterName ( ClientContext clientContext, string matterName ) : string
GetUserPrincipal ( ClientContext clientContext, Matter matter, IList userIds ) : Principal>>.List
MatterAssociatedLists ( ClientContext clientContext, ReadOnlyCollection listsNames ) : List	Function to check whether list is present or not.
RemoveSpecificUsers ( ClientContext clientContext, List usersToRemove, string loggedInUserTitle, bool isListItem, string listName, int matterLandingPageId ) : void	Removes the users' permission from list or list item.
RetrieveItemId ( ClientContext clientContext, string libraryName, string originalMatterName ) : int
SetItemPermission ( ClientContext clientContext, IList assignUserName, string listName, int listItemId, IList permissions ) : bool	Set permission to the specified list item
SetPermission ( ClientContext clientContext, IList assignUserName, IList permissions, string listName ) : bool	Sets permissions for the list.
SetPropertBagValuesForList ( ClientContext clientContext, PropertyValues props, string matterName, string>.Dictionary propertyList ) : void	Sets the value of the specified property.

Method Details

BreakItemPermission() public method

Validates and breaks the item level permission for the specified list item under the list/library.

public BreakItemPermission ( ClientContext clientContext, string listName, int listItemId, bool isCopyRoleAssignment ) : bool
clientContext	ClientContext	Client Context
listName	string	List name
listItemId	int	Unique list item id to break item level permission
isCopyRoleAssignment	bool	Flag to copy permission from parent
return	bool

BreakPermission() public static method

Breaks the permissions of the list.

public static BreakPermission ( ClientContext clientContext, string libraryName, bool isCopyRoleAssignment ) : bool
clientContext	ClientContext	Client context
libraryName	string	Name of list
isCopyRoleAssignment	bool	Flag to copy permission from parent
return	bool

CheckUserSecurity() public static method

public static CheckUserSecurity ( ClientContext clientContext, Matter matter, IList userIds ) : Principal>>.List
clientContext	ClientContext
matter	Microsoft.Legal.MatterCenter.Models.Matter
userIds	IList
return	Principal>>.List

FetchUserPermissionForLibrary() public static method

public static FetchUserPermissionForLibrary ( ClientContext clientContext, string libraryname ) : IEnumerable
clientContext	ClientContext
libraryname	string
return	IEnumerable

GetData() public static method

Gets the list items of specified list based on CAML query.

public static GetData ( ClientContext clientContext, string listName, string camlQuery = null ) : ListItemCollection
clientContext	ClientContext	Client context
listName	string	Name of the list
camlQuery	string	CAML Query that need to be executed on list
return	ListItemCollection

GetListProperties() public static method

public static GetListProperties ( ClientContext clientContext, string libraryName ) : PropertyValues
clientContext	ClientContext
libraryName	string
return	PropertyValues

GetLoggedInUserDetails() public static method

This method will return the user object who has currently logged into the system

public static GetLoggedInUserDetails ( ClientContext clientContext ) : Users
clientContext	ClientContext
return	Microsoft.Legal.MatterCenter.Models.Users

GetMatterAssignedUsersEmail() public static method

Converts the project users emails in a form that can be stamped to library.

public static GetMatterAssignedUsersEmail ( ClientContext clientContext, Matter matter ) : string
clientContext	ClientContext	ClientContext object
matter	Microsoft.Legal.MatterCenter.Models.Matter	Matter object
return	string

GetMatterName() public static method

public static GetMatterName ( ClientContext clientContext, string matterName ) : string
clientContext	ClientContext
matterName	string
return	string

GetUserPrincipal() public static method

public static GetUserPrincipal ( ClientContext clientContext, Matter matter, IList userIds ) : Principal>>.List
clientContext	ClientContext
matter	Microsoft.Legal.MatterCenter.Models.Matter
userIds	IList
return	Principal>>.List

MatterAssociatedLists() public static method

Function to check whether list is present or not.

public static MatterAssociatedLists ( ClientContext clientContext, ReadOnlyCollection listsNames ) : List
clientContext	ClientContext	Client context object for SharePoint
listsNames	ReadOnlyCollection	List name
return	List

RemoveSpecificUsers() public static method

Removes the users' permission from list or list item.

public static RemoveSpecificUsers ( ClientContext clientContext, List usersToRemove, string loggedInUserTitle, bool isListItem, string listName, int matterLandingPageId ) : void
clientContext	ClientContext	ClientContext object
usersToRemove	List	List of users
loggedInUserTitle	string
isListItem	bool	ListItem or list
listName	string
matterLandingPageId	int	List item id
return	void

RetrieveItemId() public static method

public static RetrieveItemId ( ClientContext clientContext, string libraryName, string originalMatterName ) : int
clientContext	ClientContext
libraryName	string
originalMatterName	string
return	int

SetItemPermission() public static method

Set permission to the specified list item

public static SetItemPermission ( ClientContext clientContext, IList assignUserName, string listName, int listItemId, IList permissions ) : bool
clientContext	ClientContext	Client context object
assignUserName	IList	Users to give permission
listName	string	List name
listItemId	int	Unique list item id to break item level permission
permissions	IList	Permissions for the users
return	bool

SetPermission() public static method

Sets permissions for the list.

public static SetPermission ( ClientContext clientContext, IList assignUserName, IList permissions, string listName ) : bool
clientContext	ClientContext	Client Context
assignUserName	IList	Users to give permission
permissions	IList	Permissions for the users
listName	string	List name
return	bool

SetPropertBagValuesForList() public static method

Sets the value of the specified property.

public static SetPropertBagValuesForList ( ClientContext clientContext, PropertyValues props, string matterName, string>.Dictionary propertyList ) : void
clientContext	ClientContext	Client context
props	PropertyValues	Property Bag
matterName	string	Name of matter to which property is to be attached
propertyList	string>.Dictionary	List of properties
return	void