Documentation
¶
Index ¶
- Variables
- type AttributeDescriptor
- type AttributesContainer
- type Avatar
- type AvatarSize
- type Client
- type ClientImpl
- type CoreProfileAttribute
- type CreateProfileContext
- type GeoRegion
- type GetProfileArgs
- type Profile
- type ProfileAttribute
- type ProfileAttributeBase
- type ProfileRegion
- type ProfileRegions
- type ProfileState
Constants ¶
This section is empty.
Variables ¶
View Source
var AvatarSizeValues = avatarSizeValuesType{
Small: "small",
Medium: "medium",
Large: "large",
}
View Source
var ProfileStateValues = profileStateValuesType{
Custom: "custom",
CustomReadOnly: "customReadOnly",
ReadOnly: "readOnly",
}
View Source
var ResourceAreaId, _ = uuid.Parse("8ccfef3d-2b87-4e99-8ccb-66e343d2daa8")
Functions ¶
This section is empty.
Types ¶
type AttributeDescriptor ¶
type AttributeDescriptor struct {
// The name of the attribute.
AttributeName *string `json:"attributeName,omitempty"`
// The container the attribute resides in.
ContainerName *string `json:"containerName,omitempty"`
}
Identifies an attribute with a name and a container.
type AttributesContainer ¶
type AttributesContainer struct {
// The attributes stored by the container.
Attributes *map[string]ProfileAttribute `json:"attributes,omitempty"`
// The name of the container.
ContainerName *string `json:"containerName,omitempty"`
// The maximum revision number of any attribute within the container.
Revision *int `json:"revision,omitempty"`
}
Stores a set of named profile attributes.
type Avatar ¶
type Avatar struct {
IsAutoGenerated *bool `json:"isAutoGenerated,omitempty"`
Size *AvatarSize `json:"size,omitempty"`
TimeStamp *azuredevops.Time `json:"timeStamp,omitempty"`
Value *[]byte `json:"value,omitempty"`
}
type AvatarSize ¶
type AvatarSize string
Small = 34 x 34 pixels; Medium = 44 x 44 pixels; Large = 220 x 220 pixels
type Client ¶
type Client interface {
// Gets a user profile.
GetProfile(context.Context, GetProfileArgs) (*Profile, error)
}
func NewClient ¶
func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)
type ClientImpl ¶
type ClientImpl struct {
Client azuredevops.Client
}
func (*ClientImpl) GetProfile ¶
func (client *ClientImpl) GetProfile(ctx context.Context, args GetProfileArgs) (*Profile, error)
Gets a user profile.
type CoreProfileAttribute ¶
type CoreProfileAttribute struct {
// The descriptor of the attribute.
Descriptor *AttributeDescriptor `json:"descriptor,omitempty"`
// The revision number of the attribute.
Revision *int `json:"revision,omitempty"`
// The time the attribute was last changed.
TimeStamp *azuredevops.Time `json:"timeStamp,omitempty"`
// The value of the attribute.
Value interface{} `json:"value,omitempty"`
}
A profile attribute which always has a value for each profile.
type CreateProfileContext ¶
type CreateProfileContext struct {
CiData *map[string]interface{} `json:"ciData,omitempty"`
ContactWithOffers *bool `json:"contactWithOffers,omitempty"`
CountryName *string `json:"countryName,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
EmailAddress *string `json:"emailAddress,omitempty"`
HasAccount *bool `json:"hasAccount,omitempty"`
Language *string `json:"language,omitempty"`
PhoneNumber *string `json:"phoneNumber,omitempty"`
// The current state of the profile.
ProfileState *ProfileState `json:"profileState,omitempty"`
}
type GetProfileArgs ¶
type GetProfileArgs struct {
// (required) The ID of the target user profile within the same organization, or 'me' to get the profile of the current authenticated user.
Id *string
// (optional) Return public profile information such as display name, email address, country, etc. If false, the withAttributes parameter is ignored.
Details *bool
// (optional) If true, gets the attributes (named key-value pairs of arbitrary data) associated with the profile. The partition parameter must also have a value.
WithAttributes *bool
// (optional) The partition (named group) of attributes to return.
Partition *string
// (optional) A comma-delimited list of core profile attributes to return. Valid values are Email, Avatar, DisplayName, and ContactWithOffers.
CoreAttributes *string
// (optional) Not used in this version of the API.
ForceRefresh *bool
}
Arguments for the GetProfile function
type Profile ¶
type Profile struct {
// The attributes of this profile.
ApplicationContainer *AttributesContainer `json:"applicationContainer,omitempty"`
// The core attributes of this profile.
CoreAttributes *map[string]CoreProfileAttribute `json:"coreAttributes,omitempty"`
// The maximum revision number of any attribute.
CoreRevision *int `json:"coreRevision,omitempty"`
// The unique identifier of the profile.
Id *uuid.UUID `json:"id,omitempty"`
// The current state of the profile.
ProfileState *ProfileState `json:"profileState,omitempty"`
// The maximum revision number of any attribute.
Revision *int `json:"revision,omitempty"`
// The time at which this profile was last changed.
TimeStamp *azuredevops.Time `json:"timeStamp,omitempty"`
}
A user profile.
type ProfileAttribute ¶
type ProfileAttribute struct {
// The descriptor of the attribute.
Descriptor *AttributeDescriptor `json:"descriptor,omitempty"`
// The revision number of the attribute.
Revision *int `json:"revision,omitempty"`
// The time the attribute was last changed.
TimeStamp *azuredevops.Time `json:"timeStamp,omitempty"`
// The value of the attribute.
Value interface{} `json:"value,omitempty"`
}
A named object associated with a profile.
type ProfileAttributeBase ¶
type ProfileAttributeBase struct {
// The descriptor of the attribute.
Descriptor *AttributeDescriptor `json:"descriptor,omitempty"`
// The revision number of the attribute.
Revision *int `json:"revision,omitempty"`
// The time the attribute was last changed.
TimeStamp *azuredevops.Time `json:"timeStamp,omitempty"`
// The value of the attribute.
Value interface{} `json:"value,omitempty"`
}
type ProfileRegion ¶
type ProfileRegion struct {
// The two-letter code defined in ISO 3166 for the country/region.
Code *string `json:"code,omitempty"`
// Localized country/region name
Name *string `json:"name,omitempty"`
}
Country/region information
type ProfileRegions ¶
type ProfileRegions struct {
// List of country/region code with contact consent requirement type of notice
NoticeContactConsentRequirementRegions *[]string `json:"noticeContactConsentRequirementRegions,omitempty"`
// List of country/region code with contact consent requirement type of opt-out
OptOutContactConsentRequirementRegions *[]string `json:"optOutContactConsentRequirementRegions,omitempty"`
// List of country/regions
Regions *[]ProfileRegion `json:"regions,omitempty"`
}
Container of country/region information
Click to show internal directories.
Click to hide internal directories.