Ifd:removeContextUser

From dev.ifd-library.org

Jump to: navigation, search

API version 2

Function public IfdUser [] removeContextUser (
                            String context_guid,
                            IfdUser user,
                            String session_id )

Express heading

QUERY_FUNCTION removeContextUser(
                    context_guid : STRING ;
                    user : IfdUser ) :  LIST OF IfdUser;

Function to remove a user from a context. This function requires read and write access and the user must be one of the owners.

Input:

  • string context_guid - the GUID of the context that the user should be removed from.
  • IfdUser user - The user to remove from the list of context users.
  • session_id - the session id for the current user

Return:

  • IfdUser [] - An array containing the updated list of all users for the given context.

API version 3

Function public IfdUser [] removeContextUser (
                            String session_id,
                            String context_guid,
                            IfdUser user)

Express Heading

QUERY_FUNCTION removeContextUser(
                      context_guid : STRING ;
                      user : IfdUser ) :  LIST OF IfdUser;

The function removes a user from specified context.

Input:

  • session_id - the session id for the current user
  • string context_guid - global unique id of the target IFD context;
  • IfdUser user - IFD user to be removed from the context’s users, it shall be user.guid (database login) is specified

Return:

  • IfdUser [] - List of the context users after the remove (see description of attributes in getUsers).

Difference against v.2.00

  • (119) In v.2.00 the function did not check if the logged user is the target context owner


Back to the API

Comments: