ClientUserAddressBookLookup Method |
Given a piece of identifying information, determines if the referenced user or group is a
member of the currently authorized user's address book.
Namespace: MOVEit.DMZ.APIAssembly: MOVEit.DMZ.API (in MOVEit.DMZ.API.dll) Version: 9.0.0.0
Syntax public Dictionary<string, string> UserAddressBookLookup(
string Value,
ClientAddressBookLookupType Type
)
Public Function UserAddressBookLookup (
Value As String,
Type As ClientAddressBookLookupType
) As Dictionary(Of String, String)
public:
Dictionary<String^, String^>^ UserAddressBookLookup(
String^ Value,
ClientAddressBookLookupType Type
)
Parameters
- Value
- Type: SystemString
A username, realname, groupname, or email address to search the current user's address book for. - Type
- Type: MOVEit.DMZ.APIClientAddressBookLookupType
Lookup type specifying the nature of the Value argument.
Return Value
Type:
DictionaryString,
StringDictionary containing search results if successful; otherwise,
null.
Remarks
If the referenced entity is not a member of the currently authorized user's address book,
also returns information indicating if this entity could be added to the
currently authorized user's address book. Returns null if the entity
cannot be added to the currently authorized user's address book. Returns an empty
Dictionary if the entity is not in the currently authorized user's address book, but
may be added as a temporary user. (Email addresses only.) Returns a Dictionary
containing one or more usernames or group names if the entity is in the currently
authorized user's address book.
See Also