IVsCredential Interface
Represents a credential for sign-in purposes.
Namespace: Microsoft.VisualStudio.Shell.Connected.CredentialStorage
Assembly: Microsoft.VisualStudio.Shell.Immutable.12.0 (in Microsoft.VisualStudio.Shell.Immutable.12.0.dll)
Syntax
'Declaration
Public Interface IVsCredential _
Inherits IVsCredentialKey
public interface IVsCredential : IVsCredentialKey
public interface class IVsCredential : IVsCredentialKey
type IVsCredential =
interface
interface IVsCredentialKey
end
public interface IVsCredential extends IVsCredentialKey
The IVsCredential type exposes the following members.
Properties
Name | Description | |
---|---|---|
FeatureName | Gets or sets the feature name. Feature names are case-sensitive. (Inherited from IVsCredentialKey.) | |
Resource | Gets or sets the credential resource name or URI. Resources are case-insensitive. (Inherited from IVsCredentialKey.) | |
TokenValue | Gets or sets the last token value. | |
Type | The type of the credential. This can be any app-specific value, but is intended to convey the authentication type. Therefore some examples might be: "Federated", "OAuth", "Windows", "Basic", "ServiceIdentity", "S2S". The type is case-insensitive. (Inherited from IVsCredentialKey.) | |
UserName | Gets or sets the credential user name, user ID, or any app-specific unique value. The user name is case-insensitive. (Inherited from IVsCredentialKey.) |
Top
Methods
Name | Description | |
---|---|---|
GetProperty | Gets a property related to the credential out of storage. The name cannot be null or empty, or whitespace. If the property cannot be found or the underlying credential has been deleted null will be returned. Property names are case insensitive | |
RefreshTokenValue | Gets the token value (secret) for this credential. If the underlying credential has been deleted, TokenValue is an empty string, and false is returned. | |
SetProperty | Se s a property related to the credential in storage. To remove a property, you must remove the token itself from storage. The name cannot be null or empty, or whitespace. The value cannot be null. If the underlying credential could not be found, false is returned. Setting the same name again will overwrite the property. Property names are case-insensitive | |
SetTokenValue | Sets the token value (secret) for this credential. If the underlying credential has already been deleted it gets re-added with the new token value. The token cannot be null or empty, or whitespace. |
Top
See Also
Reference
Microsoft.VisualStudio.Shell.Connected.CredentialStorage Namespace