Class UafClient

    Definition

    Namespace:
    Tizen.Account.FidoClient
    Assembly:
    Tizen.Account.FidoClient.dll

    The FIDO UAF Client APIs

    [Obsolete("Deprecated since API11. Might be removed in API13.")]
    public static class UafClient
    Inheritance
    object
    UafClient

    Properties

    View Source

    MajorVersion

    The FIDO Client Major version

    Declaration
    [Obsolete("Deprecated since API11. Might be removed in API13.")]
    public static int MajorVersion { get; }
    Property Value
    Type Description
    int
    View Source

    MinorVersion

    The FIDO Client Minor version

    Declaration
    [Obsolete("Deprecated since API11. Might be removed in API13.")]
    public static int MinorVersion { get; }
    Property Value
    Type Description
    int
    View Source

    StautsOk

    The FIDO Server response for successfull interaction.

    Declaration
    [Obsolete("Deprecated since API11. Might be removed in API13.")]
    public static int StautsOk { get; }
    Property Value
    Type Description
    int
    View Source

    VendorName

    The FIDO Client vendor name

    Declaration
    [Obsolete("Deprecated since API11. Might be removed in API13.")]
    public static string VendorName { get; }
    Property Value
    Type Description
    string

    Methods

    View Source

    CheckPolicyAsync(UafMessage)

    Checks whether the FIDO message can be processed

    Declaration
    [Obsolete("Deprecated since API11. Might be removed in API13.")]
    public static Task<bool> CheckPolicyAsync(UafMessage uafMessage)
    Parameters
    Type Name Description
    UafMessage uafMessage

    The FIDO UAF message which is received from the relying party server

    Returns
    Type Description
    System.Threading.Tasks.Task<TResult><bool>

    True if the message can be handled by the device, else false

    Examples
        UafMessage uafRequest = new UafMessage()
        {
            Operation = "UafRequestJson"
        };
        bool response = await UafClient.CheckPolicyAsync(uafRequest);
    Exceptions
    Type Condition
    System.ArgumentException

    In case of invalid parameter

    System.UnauthorizedAccessException

    Thrown when the application does not have privilege to access this method

    System.NotSupportedException

    FIDO is not supported

    View Source

    NotifyResultAsync(int, UafResponse)

    Notifies the FIDO client about the server result. FIDO Server sends the result of processing a UAF message to FIDO client.

    Declaration
    [Obsolete("Deprecated since API11. Might be removed in API13.")]
    public static Task NotifyResultAsync(int responseCode, UafResponse response)
    Parameters
    Type Name Description
    int responseCode

    The status code received from Server.(StautsOk implies success)

    UafResponse response

    The FIDO response message sent to server in JSON format

    Returns
    Type Description
    System.Threading.Tasks.Task
    Remarks

    This is especially important for cases when a new registration may be considered by the client to be in a pending state until it is communicated that the server accepted it

    Examples
        UafResponse response = new UafResponse()
        {
            Response = "Responsejson"
        };
    
        await UafClient.NotifyResultAsync(UafClient.StautsOk, response);
    Exceptions
    Type Condition
    System.ArgumentException

    In case of invalid parameter

    System.UnauthorizedAccessException

    Thrown when the application does not have privilege to access this method

    System.NotSupportedException

    FIDO is not supported

    View Source

    ProcessRequestAsync(UafMessage, string)

    Processes the given FIDO UAF message.

    Declaration
    [Obsolete("Deprecated since API11. Might be removed in API13.")]
    public static Task<UafResponse> ProcessRequestAsync(UafMessage uafMessage, string channelBindng)
    Parameters
    Type Name Description
    UafMessage uafMessage

    The FIDO UAF message which is received from the relying party server

    string channelBindng

    The channel binding data in JSON format which is received from the relying party server

    Returns
    Type Description
    System.Threading.Tasks.Task<TResult><UafResponse>

    FIDO response message

    Examples
        UafMessage uafRequest = new UafMessage()
        {
            Operation = "UafAuthRequestJson"
        };
    
        var response = await UafClient.ProcessRequestAsync(uafRequest, null);
    Exceptions
    Type Condition
    System.ArgumentException

    In case of invalid parameter

    System.UnauthorizedAccessException

    Thrown when the application does not have privilege to access this method

    System.NotSupportedException

    FIDO is not supported

    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX