Share via


SP.Utilities.Utility.resolvePrincipal(Context, web, input, scopes, sources, usersContainer, inputIsEmailOnly) Method

Applies to: SharePoint Foundation 2010

In this article
Return Value
Remarks
Applies To

Gets information about a principal that matches the specified Search criteria.

var value = SP.Utilities.Utility.resolvePrincipal(Context, web, input, scopes, sources, usersContainer, inputIsEmailOnly);

Parameters

Context

Type: SP.ClientRuntimeContext

The runtime context for accessing data from and invoking methods on remote objects.

web

Type: SP.Web

The site to be used when searching for a principal.

input

Type: string

The display name, email address, or login name of the principal.scopes

Type: SP.Utilities.PrincipalType

The type of the principal.

sources

Type: SP.Utilities.PrincipalSource

The source of the principal.

usersContainer

Type: SP.UserCollection

The users containing the principal.

inputIsEmailOnly

Type: Boolean

Specifies whether only the email address is used when searching for the principal.

Return Value

Type: SP.Utilities.PrincipalInfo

Information about the principal.

Remarks

This method returns null if input is null or empty, or a matching principal cannot be found.

Applies To

SP.Utilities.Utility Class

See Also

Reference

SP.Utilities.Utility Methods

SP.Utilities Namespace