UserHandle Interface

Note: This API is now obsolete.

Provides access to the entitlements for a specific user.

Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.11.1

Syntax

C++

Copy

[ObsoleteAttribute("Deprecated as of 3.3.0, use Identity")]
public interface UserHandle : Identity

<ObsoleteAttribute("Deprecated as of 3.3.0, use Identity")>
Public Interface UserHandle
	Inherits Identity

[ObsoleteAttribute(L"Deprecated as of 3.3.0, use Identity")]
public interface class UserHandle : Identity

[<ObsoleteAttribute("Deprecated as of 3.3.0, use Identity")>]
type UserHandle =  
    interface
        interface Identity
    end

The UserHandle type exposes the following members.

Properties

	Name	Description
	SeatType	Returns SeatType value of this identity. (Inherited from Identity.)

Top

Methods

	Name	Description
	HasEntitlements(Int32, Service)	Returns true if the user has the specified entitlements for the specified Service. (Inherited from Identity.)
	HasEntitlements(Element, Service)	Returns true if the user has the specified entitlements for the specified Service. (Inherited from Identity.)
	HasEntitlements(Int32, Service, ListInt32)	Returns true if the user has the specified entitlements for the specified Service. (Inherited from Identity.)
	HasEntitlements(Element, Service, ListInt32)	Returns true if the user has the specified entitlements for the specified Service. (Inherited from Identity.)
	IsAuthorized	Returns true if the user handle is authorized for the specified Service. (Inherited from Identity.)

Top

Remarks

An unauthorized UserHandle is created using CreateUserHandle. Once a UserHandle has been created it can be authorized using SendAuthorizationRequest(). The authorized UserHandle can then be used in Subscribe() or SendRequest() calls. Once authorized a UserHandle has access to the entitlements of the user which it was validated for and can then be queried to see if a user is entitled to receive data.

Reference

Bloomberglp.Blpapi Namespace