Class Auth
- Namespace
- Soup
- Assembly
- Soup-3.0.dll
public class Auth : Object, IDisposable, NativeObject, GTypeProvider, InstanceFactory
- Inheritance
-
Auth
- Implements
- Derived
- Inherited Members
Constructors
Auth(params ConstructArgument[])
[Obsolete("Regular C# constructors on native classes will be removed in a future version. Please see the linked documentation for more details. It contains scenarios and possible solutions to prepare for the upcoming changes.", DiagnosticId = "GirCore1007", UrlFormat = "https://gircore.github.io/docs/integration/diagnostic/1007.html")]
public Auth(params ConstructArgument[] constructArguments)
Parameters
constructArgumentsConstructArgument[]
Auth(CreationData)
[Obsolete("This constructor is a workaround to keep legacy APIs alive. Do not use it.")]
protected Auth(CreationData data)
Parameters
dataCreationData
Auth(AuthHandle)
protected Auth(AuthHandle handle)
Parameters
handleAuthHandle
Fields
AuthorityPropertyDefinition
public static readonly Property<string?, Auth> AuthorityPropertyDefinition
Field Value
IsAuthenticatedPropertyDefinition
public static readonly Property<bool, Auth> IsAuthenticatedPropertyDefinition
Field Value
IsCancelledPropertyDefinition
public static readonly Property<bool, Auth> IsCancelledPropertyDefinition
Field Value
IsForProxyPropertyDefinition
public static readonly Property<bool, Auth> IsForProxyPropertyDefinition
Field Value
RealmPropertyDefinition
public static readonly Property<string?, Auth> RealmPropertyDefinition
Field Value
SchemeNamePropertyDefinition
public static readonly Property<string?, Auth> SchemeNamePropertyDefinition
Field Value
Properties
Authority
public string? Authority { get; set; }
Property Value
IsAuthenticated
public bool IsAuthenticated { get; }
Property Value
IsCancelled
public bool IsCancelled { get; }
Property Value
IsForProxy
public bool IsForProxy { get; set; }
Property Value
Realm
public string? Realm { get; set; }
Property Value
SchemeName
public string? SchemeName { get; }
Property Value
Methods
Authenticate(string, string)
public void Authenticate(string username, string password)
Parameters
CanAuthenticate()
public bool CanAuthenticate()
Returns
Cancel()
public void Cancel()
FreeProtectionSpace(SList)
public void FreeProtectionSpace(SList space)
Parameters
spaceSList
GetAuthority()
public string GetAuthority()
Returns
GetAuthorization(Message)
public string GetAuthorization(Message msg)
Parameters
msgMessage
Returns
GetGType()
public static Type GetGType()
Returns
GetInfo()
public string GetInfo()
Returns
GetIsAuthenticated()
public bool GetIsAuthenticated()
Returns
GetIsCancelled()
public bool GetIsCancelled()
Returns
GetIsForProxy()
public bool GetIsForProxy()
Returns
GetProtectionSpace(Uri)
public SList GetProtectionSpace(Uri sourceUri)
Parameters
sourceUriUri
Returns
GetRealm()
public string GetRealm()
Returns
GetSchemeName()
public string GetSchemeName()
Returns
IsReady(Message)
public bool IsReady(Message msg)
Parameters
msgMessage
Returns
New(Type, Message, string)
public static Auth? New(Type type, Message msg, string authHeader)
Parameters
Returns
NewFromPointer(nint, bool)
Creates a new managed Auth instance for a given pointer.
public static Auth NewFromPointer(nint ptr, bool ownsHandle)
Parameters
Returns
NewWithProperties(ConstructArgument[])
Creates a new Auth and sets the properties specified by the construct arguments.
public static Auth NewWithProperties(ConstructArgument[] constructArguments)
Parameters
constructArgumentsConstructArgument[]The properties to set.
Returns
Update(Message, string)
public bool Update(Message msg, string authHeader)