{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.2.2", "schemaVersion": 1001, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", "canonicalReference": "@digitalpersona/core", "docComment": "", "name": "@digitalpersona/core", "members": [ { "kind": "EntryPoint", "canonicalReference": "", "name": "", "members": [ { "kind": "Class", "canonicalReference": "(Answer:class)", "docComment": "/**\n * An answer to a security question.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Answer" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Answer", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Creates an answer to a security question.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "question" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Question" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "QuestionNumber" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "text" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "question", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ] }, { "kind": "Property", "canonicalReference": "(number:instance)", "docComment": "/**\n * An index of a question in a question list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "number" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "QuestionNumber" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "number", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(text:instance)", "docComment": "/**\n * A text of the answer. Must be given in correponding {@link Question.keyboard_layout | keyboard layout}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "text" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(version:instance)", "docComment": "/**\n * Version info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "version" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "1" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Base32:class)", "docComment": "/**\n * Set of converters to Base32.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Base32" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Base32", "members": [ { "kind": "Method", "canonicalReference": "(fromBytes:static,0)", "docComment": "/**\n * Converts a byte array to a Base32-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBytes" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "bytes" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Uint8Array" }, { "kind": "Content", "text": " | number[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Base32String" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "bytes", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 } } ], "name": "fromBytes" } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Base64:class)", "docComment": "/**\n * Set of converters to Base64.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Base64" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Base64", "members": [ { "kind": "Property", "canonicalReference": "(fromBase64Url:static)", "docComment": "/**\n * Converts a Base64url-encoded string to a Base64-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBase64Url" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBase64Url", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromBytes:static)", "docComment": "/**\n * Converts a byte array to a Base64-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBytes" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "bytes" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Uint8Array" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBytes", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromJSON:static)", "docComment": "/**\n * Encodes a plain JSON object or a string to a Base64-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromJSON" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "obj" }, { "kind": "Content", "text": ": string | object) => " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromJSON", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromUtf16:static)", "docComment": "/**\n * Encodes a UTF16 string to a Base64-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromUtf16" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromUtf16", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromUtf8:static)", "docComment": "/**\n * Encodes a UTF8 string to a Base64-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromUtf8" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromUtf8", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Base64Url:class)", "docComment": "/**\n * Set of converters to Base64Url.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Base64Url" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Base64Url", "members": [ { "kind": "Property", "canonicalReference": "(fromBase64:static)", "docComment": "/**\n * Converts a Base64-encoded string to a Base64url-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBase64" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBase64", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromBytes:static)", "docComment": "/**\n * Converts a byte array to a Base64url-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBytes" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "bytes" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Uint8Array" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBytes", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromJSON:static)", "docComment": "/**\n * Encodes a plain JSON object or a string to a Base64url-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromJSON" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "obj" }, { "kind": "Content", "text": ": string | object) => " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromJSON", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromUtf16:static)", "docComment": "/**\n * Converts a UTF16 string to a Base64url-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromUtf16" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromUtf16", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromUtf8:static)", "docComment": "/**\n * Converts a UTF8 string to a Base64url-encoded string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromUtf8" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromUtf8", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(BioFactor:enum)", "docComment": "/**\n * Biometric factors.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "BioFactor" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BioFactor", "members": [ { "kind": "EnumMember", "canonicalReference": "FacialFeatures", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "FacialFeatures" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "FacialFeatures", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Fingerprint", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Fingerprint" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "8" } ], "releaseTag": "Public", "name": "Fingerprint", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Gait", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Gait" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4096" } ], "releaseTag": "Public", "name": "Gait", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "HandGeometry", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "HandGeometry" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "64" } ], "releaseTag": "Public", "name": "HandGeometry", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Iris", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Iris" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "16" } ], "releaseTag": "Public", "name": "Iris", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "KeystrokeDynamics", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "KeystrokeDynamics" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "256" } ], "releaseTag": "Public", "name": "KeystrokeDynamics", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LipMovement", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LipMovement" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "512" } ], "releaseTag": "Public", "name": "LipMovement", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Multiple", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Multiple" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Multiple", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Retina", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Retina" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "32" } ], "releaseTag": "Public", "name": "Retina", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "SignatureDynamics", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "SignatureDynamics" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "128" } ], "releaseTag": "Public", "name": "SignatureDynamics", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "ThermalFaceImage", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ThermalFaceImage" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1024" } ], "releaseTag": "Public", "name": "ThermalFaceImage", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "ThermalHandImage", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ThermalHandImage" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2048" } ], "releaseTag": "Public", "name": "ThermalHandImage", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Voice", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Voice" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "Voice", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(BioSample:class)", "docComment": "/**\n * A biometric sample.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "BioSample" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BioSample", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `BioSample` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(\n " }, { "kind": "Reference", "text": "Header" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleHeader" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "Data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "Header", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "Data", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ] }, { "kind": "Property", "canonicalReference": "(Data:instance)", "docComment": "/**\n * Base64url encoded biometric sample data\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "Data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Data", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(Header:instance)", "docComment": "/**\n * Biometric sample header.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "Header" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleHeader" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Header", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(Version:instance)", "docComment": "/**\n * A version info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "Version" }, { "kind": "Content", "text": " = 1;" } ], "releaseTag": "Public", "name": "Version", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(BioSampleEncryption:enum)", "docComment": "/**\n * A biometric sample encryption type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "BioSampleEncryption" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BioSampleEncryption", "members": [ { "kind": "EnumMember", "canonicalReference": "None", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "None" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "None", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "XTEA", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "XTEA" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "XTEA", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(BioSampleFormat:class)", "docComment": "/**\n * Biometric sample format info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "BioSampleFormat" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BioSampleFormat", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `BioSampleFormat` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "FormatOwner" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleFormatOwner" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FormatID" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "FormatOwner", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "FormatID", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ] }, { "kind": "Property", "canonicalReference": "(FormatID:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "FormatID" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "FormatID", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(FormatOwner:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "FormatOwner" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleFormatOwner" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "FormatOwner", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(BioSampleFormatOwner:enum)", "docComment": "/**\n * Biometric owner ID registered with {@link http://www.ibia.org/base/cbeff/_biometric_org.phpx | IBIA}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "BioSampleFormatOwner" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BioSampleFormatOwner", "members": [ { "kind": "EnumMember", "canonicalReference": "Cognitec", "docComment": "/**\n * Cognitec (face)\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Cognitec" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "99" } ], "releaseTag": "Public", "name": "Cognitec", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "DigitalPersona", "docComment": "/**\n * DigitalPersona (fingerprints)\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DigitalPersona" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "51" } ], "releaseTag": "Public", "name": "DigitalPersona", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Innovatrics", "docComment": "/**\n * Innovatrics (face)\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Innovatrics" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "53" } ], "releaseTag": "Public", "name": "Innovatrics", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Neurotechnologija", "docComment": "/**\n * Neurotechnologija (fingerprints).\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Neurotechnologija" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "49" } ], "releaseTag": "Public", "name": "Neurotechnologija", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "None", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "None" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "None", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(BioSampleHeader:class)", "docComment": "/**\n * Contains meta-information about biometric sample data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "BioSampleHeader" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BioSampleHeader", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `BioSampleHeader` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(\n " }, { "kind": "Reference", "text": "Factor" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioFactor" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "Format" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleFormat" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleType" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "Purpose" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSamplePurpose" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "Quality" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "Encryption" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleEncryption" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "Factor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "Format", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } }, { "parameterName": "Type", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "Purpose", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } }, { "parameterName": "Quality", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 } }, { "parameterName": "Encryption", "parameterTypeTokenRange": { "startIndex": 23, "endIndex": 24 } } ] }, { "kind": "Property", "canonicalReference": "(Encryption:instance)", "docComment": "/**\n * Encryption of biometric sample.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Encryption" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleEncryption" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Encryption", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(Factor:instance)", "docComment": "/**\n * Biometric factor. Must be set to 8 for fingerprint.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Factor" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioFactor" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Factor", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(Format:instance)", "docComment": "/**\n * Format owner (vendor) information.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Format" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleFormat" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Format", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(Purpose:instance)", "docComment": "/**\n * Purpose of the biometric sample.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Purpose" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSamplePurpose" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Purpose", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(Quality:instance)", "docComment": "/**\n * Quality of biometric sample. If we don't support quality it should be set to -1.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Quality" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Quality", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(Type:instance)", "docComment": "/**\n * Biometric sample representation type.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSampleType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(BioSamplePurpose:enum)", "docComment": "/**\n * A purpose the biometric sample was intended for.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "BioSamplePurpose" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BioSamplePurpose", "members": [ { "kind": "EnumMember", "canonicalReference": "Any", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Any" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Any", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Audit", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Audit" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "6" } ], "releaseTag": "Public", "name": "Audit", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Enroll", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Enroll" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "3" } ], "releaseTag": "Public", "name": "Enroll", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "EnrollForIdentificationOnly", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "EnrollForIdentificationOnly" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "5" } ], "releaseTag": "Public", "name": "EnrollForIdentificationOnly", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "EnrollForVerificationOnly", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "EnrollForVerificationOnly" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "EnrollForVerificationOnly", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Identify", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Identify" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "Identify", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Verify", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Verify" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Verify", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Enum", "canonicalReference": "(BioSampleType:enum)", "docComment": "/**\n * A representation type of a biometric sample.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "BioSampleType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BioSampleType", "members": [ { "kind": "EnumMember", "canonicalReference": "Encrypted", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Encrypted" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "16" } ], "releaseTag": "Public", "name": "Encrypted", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Intermediate", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Intermediate" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "Intermediate", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Processed", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Processed" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "Processed", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Raw", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Raw" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Raw", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RawWSQCompressed", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RawWSQCompressed" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "8" } ], "releaseTag": "Public", "name": "RawWSQCompressed", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Signed", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Signed" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "32" } ], "releaseTag": "Public", "name": "Signed", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Enum", "canonicalReference": "(ClaimName:enum)", "docComment": "/**\n * Enumerate publicly registered and private DigitalPersona claim names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "ClaimName" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ClaimName", "members": [ { "kind": "EnumMember", "canonicalReference": "ADGuid", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ADGuid" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"ad_guid\"" } ], "releaseTag": "Public", "name": "ADGuid", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Audience", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Audience" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"aud\"" } ], "releaseTag": "Public", "name": "Audience", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "CredentialsUsed", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "CredentialsUsed" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"crd\"" } ], "releaseTag": "Public", "name": "CredentialsUsed", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "ExpiresAfter", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ExpiresAfter" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"exp\"" } ], "releaseTag": "Public", "name": "ExpiresAfter", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Group", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Group" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"group\"" } ], "releaseTag": "Public", "name": "Group", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "IssuedAt", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "IssuedAt" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"iat\"" } ], "releaseTag": "Public", "name": "IssuedAt", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "IssuerDomain", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "IssuerDomain" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"dom\"" } ], "releaseTag": "Public", "name": "IssuerDomain", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "IssuerName", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "IssuerName" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"iss\"" } ], "releaseTag": "Public", "name": "IssuerName", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "NotBefore", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "NotBefore" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"nbf\"" } ], "releaseTag": "Public", "name": "NotBefore", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Role", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Role" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"role\"" } ], "releaseTag": "Public", "name": "Role", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "SubjectName", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "SubjectName" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"sub\"" } ], "releaseTag": "Public", "name": "SubjectName", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "SubjectUid", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "SubjectUid" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"uid\"" } ], "releaseTag": "Public", "name": "SubjectUid", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "T24Principal", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "T24Principal" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"t24\"" } ], "releaseTag": "Public", "name": "T24Principal", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "TokensId", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "TokensId" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"jti\"" } ], "releaseTag": "Public", "name": "TokensId", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "WindowsAccountName", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "WindowsAccountName" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"wan\"" } ], "releaseTag": "Public", "name": "WindowsAccountName", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Interface", "canonicalReference": "(ClaimSet:interface)", "docComment": "/**\n * Set of claims passed in a JSON Web Token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ClaimSet" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ClaimSet", "members": [ { "kind": "PropertySignature", "canonicalReference": "aud", "docComment": "/**\n * \"Audience\" claim.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "aud" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "aud", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "crd", "docComment": "/**\n * \"Credentials\" claim. List of credentials used by the subject for authentication. Private DigitalPersona claim.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "crd" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "CredentialUsed" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "crd", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "dom", "docComment": "/**\n * \"Domain\" claim. Subject's security domain. Private DigitalPersona claim.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "dom" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "dom", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "exp", "docComment": "/**\n * \"Expiration\" claim. Number of seconds since Unix Epoch to the time when the JWT must expire.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "exp" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "exp", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "group", "docComment": "/**\n * \"Group\" claim. List of groups the subject is a member of.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "group" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "group", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "iat", "docComment": "/**\n * \"Issued At Time\" claim. Number of seconds since Unix Epoch to the time when the JWT was issued.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "iat" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "iat", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "iss", "docComment": "/**\n * \"Issuer\" claim. Name of the issuing agency.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "iss" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "iss", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "jti", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "jti" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "jti", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "nbf", "docComment": "/**\n * \"Not Before\" claim. Number of seconds since Unix Epoch to the time when the JWT becomes effective.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "nbf" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "nbf", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "role", "docComment": "/**\n * \"Role\" claim. List of roles the subject belongs to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "role" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "role", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "sub", "docComment": "/**\n * \"Subject\" claim. Name of a subject the token was issued to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "sub" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "sub", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "t24", "docComment": "/**\n * \"T24\" claim. Subject ID in Temenos T24 system.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "t24" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "t24", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "uid", "docComment": "/**\n * \"Unique ID\" claim. Subject's Unique ID. Private DigitalPersona claim.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "uid" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "uid", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "wan", "docComment": "/**\n * \"Windows Account Name\" claim. Subjects name in Windows SAM format.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "wan" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "wan", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Credential:class)", "docComment": "/**\n * Credential data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Credential", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a credential.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | object | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "encode" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } }, { "parameterName": "encode", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ] }, { "kind": "Method", "canonicalReference": "(Any:static,0)", "docComment": "/**\n * Constructs a credential object representing any credential.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "Any" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "Any" }, { "kind": "Property", "canonicalReference": "(Behavior:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "Behavior" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Behavior", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(Bluetooth:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "Bluetooth" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Bluetooth", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(Cards:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "Cards" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Cards", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(ContactlessCard:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "ContactlessCard" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ContactlessCard", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(data:instance)", "docComment": "/**\n * Base64url-encoded credential data. Format of data depends on credential type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(Email:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "Email" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Email", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(Face:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "Face" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Face", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(Fingerprints:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "Fingerprints" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Fingerprints", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(id:instance)", "docComment": "/**\n * Credential ID\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(IWA:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "IWA" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "IWA", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Method", "canonicalReference": "(None:static,0)", "docComment": "/**\n * Constructs an empty credential object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "None" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "None" }, { "kind": "Property", "canonicalReference": "(OneTimePassword:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "OneTimePassword" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "OneTimePassword", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(Password:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "Password" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Password", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(PIN:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "PIN" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "PIN", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(ProximityCard:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "ProximityCard" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ProximityCard", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(SecurityQuestions:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "SecurityQuestions" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "SecurityQuestions", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(SmartCard:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "SmartCard" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "SmartCard", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(U2F:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "U2F" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "U2F", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(CredentialUsed:interface)", "docComment": "/**\n * Claim information about a credential used. See {@link ClaimSet.crd}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "CredentialUsed" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "CredentialUsed", "members": [ { "kind": "PropertySignature", "canonicalReference": "id", "docComment": "/**\n * Credential ID\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "time", "docComment": "/**\n * Time when the credential was used, in seconds of a Unix Epoch.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "time" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "time", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(FaceImage:class)", "docComment": "/**\n * Face image data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "FaceImage" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FaceImage", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `FaceImage` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(\n " }, { "kind": "Reference", "text": "ImageData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "ImageType" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "FaceImageType" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ImageData", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "ImageType", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ] }, { "kind": "Method", "canonicalReference": "(fromCanvas:static,0)", "docComment": "/**\n * Extracts face image from a browser's canvas object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromCanvas" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "canvas" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "HTMLCanvasElement" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "quality" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FaceImage" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "canvas", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "quality", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "fromCanvas" }, { "kind": "Method", "canonicalReference": "(fromDataURL:static,0)", "docComment": "/**\n * Extracts face image from a data URL. Only `data:image/jpeg;base64` is supported for now.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromDataURL" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "image" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FaceImage" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "image", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "fromDataURL" }, { "kind": "Property", "canonicalReference": "(ImageData:instance)", "docComment": "/**\n * Base64url-encoded image data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "ImageData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ImageData", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(ImageType:instance)", "docComment": "/**\n * Image format.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "ImageType" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "FaceImageType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ImageType", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(toBioSample:instance,0)", "docComment": "/**\n * Exports the face image data to a {@link BioSample} object.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "toBioSample" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "format" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "BioSampleFormat" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "purpose" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "BioSamplePurpose" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "sdkVersion" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BioSample" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "format", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "purpose", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "sdkVersion", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "toBioSample" }, { "kind": "Property", "canonicalReference": "(Version:instance)", "docComment": "/**\n * Version info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "Version" }, { "kind": "Content", "text": " = 1;" } ], "releaseTag": "Public", "name": "Version", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(FaceImageType:enum)", "docComment": "/**\n * Format of a face image sample.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "FaceImageType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FaceImageType", "members": [ { "kind": "EnumMember", "canonicalReference": "Jpeg", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Jpeg" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Jpeg", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(Finger:class)", "docComment": "/**\n * Finger enrollment data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Finger" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Finger", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `Finger` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(\n " }, { "kind": "Reference", "text": "position" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "FingerPosition" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "position", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(fromJson:static,0)", "docComment": "/**\n * Creates the finger enrollment data from a plain JSON object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromJson" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "json" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Finger" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "json", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "fromJson" }, { "kind": "Property", "canonicalReference": "(position:instance)", "docComment": "/**\n * Finger position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "position" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "FingerPosition" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(FingerPosition:enum)", "docComment": "/**\n * Positions of fingers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "FingerPosition" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FingerPosition", "members": [ { "kind": "EnumMember", "canonicalReference": "LeftIndex", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftIndex" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "7" } ], "releaseTag": "Public", "name": "LeftIndex", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LeftLittle", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftLittle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "10" } ], "releaseTag": "Public", "name": "LeftLittle", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LeftMiddle", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftMiddle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "8" } ], "releaseTag": "Public", "name": "LeftMiddle", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LeftRing", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftRing" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "9" } ], "releaseTag": "Public", "name": "LeftRing", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LeftThumb", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftThumb" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "6" } ], "releaseTag": "Public", "name": "LeftThumb", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightIndex", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightIndex" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "RightIndex", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightLittle", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightLittle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "5" } ], "releaseTag": "Public", "name": "RightLittle", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightMiddle", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightMiddle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "3" } ], "releaseTag": "Public", "name": "RightMiddle", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightRing", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightRing" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "RightRing", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightThumb", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightThumb" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "RightThumb", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Unknown", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Unknown" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Unknown", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(JWT:class)", "docComment": "/**\n * Represents a JSON Web Token and gives access to the token's payload. Note that this class does not allow to validate the token signature in the browser, it must be done on a server side.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "JWT" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "JWT", "members": [ { "kind": "Method", "canonicalReference": "(claims:static,0)", "docComment": "/**\n * Extracts a claims set from the JSON Web Token.\n *\n * @param jwt - a JSON Web Token string.\n *\n * @returns a claims set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "claims" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "jwt" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ClaimSet" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "jwt", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "claims" }, { "kind": "Method", "canonicalReference": "(errors:static,0)", "docComment": "/**\n * Validates the JSON Web Token and returns a collection of detected validation errors.\n *\n * @remarks\n *\n * Only client-side checks are performed, no signature validation. The token's claims must satisfy following expression: `iat <= nbf < now < exp` where `iat` is time when the token was issued, `nbf` is a time when the token becomes valid, `exp` is a token expiration time, `now` is current time. Following errors may be returned:\n *\n * * 'JWT.Error.IssueTimeLaterThanNotBefore' if `iat > nbf`, * 'JWT.Error.NotEffectiveYet' when `now < nbf`, * 'JWT.Error.Expired' when `now >= exp`.\n *\n * @param jwt - a JSON Web Token.\n *\n * @returns an array of errors found, or `null` if the token is valid.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "errors" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "jwt" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Error" }, { "kind": "Content", "text": "[] | null" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "jwt", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "errors" } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Question:class)", "docComment": "/**\n * Security question data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Question" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Question", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a security question.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(\n " }, { "kind": "Reference", "text": "number" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "QuestionNumber" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "lang_id" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "sublang_id" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "keyboard_layout" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "text" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "number", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "lang_id", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } }, { "parameterName": "sublang_id", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "keyboard_layout", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } }, { "parameterName": "text", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 } } ] }, { "kind": "Method", "canonicalReference": "(fromJson:static,0)", "docComment": "/**\n * Creates a security question from a plain JSON object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromJson" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "json" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Question" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "json", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "fromJson" }, { "kind": "Property", "canonicalReference": "(keyboard_layout:instance)", "docComment": "/**\n * A keyboard layout for the answer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "keyboard_layout" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "keyboard_layout", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(lang_id:instance)", "docComment": "/**\n * A question language ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "lang_id" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "lang_id", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(number:instance)", "docComment": "/**\n * An index of a question in a question list.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "number" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "QuestionNumber" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "number", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(sublang_id:instance)", "docComment": "/**\n * A question sublanguage ID.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "sublang_id" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "sublang_id", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(text:instance)", "docComment": "/**\n * A text of the security question (only when {@link Question.type} === {@link QuestionType.Custom})\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "text" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | undefined" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "text", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(type:instance)", "docComment": "/**\n * Security question type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "QuestionType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(version:instance)", "docComment": "/**\n * Version info.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "version" }, { "kind": "Content", "text": " = 1;" } ], "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(QuestionType:enum)", "docComment": "/**\n * Type of a security question.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "QuestionType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "QuestionType", "members": [ { "kind": "EnumMember", "canonicalReference": "Custom", "docComment": "/**\n * A user-defined security question ({@link Question.number} > 100).\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Custom" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Custom", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Regular", "docComment": "/**\n * A security question from a standard predefined list of questions ({@link Question.number} <= 100).\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Regular" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Regular", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Interface", "canonicalReference": "(QuestionWithAnswer:interface)", "docComment": "/**\n * A structure associating a sequrity question with its corresponding answer.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "QuestionWithAnswer" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "QuestionWithAnswer", "members": [ { "kind": "PropertySignature", "canonicalReference": "answer", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "answer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Answer" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "answer", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "question", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "question" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Question" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "question", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Ticket:class)", "docComment": "/**\n * A structure wrapping a JSON Web Token to pass it to the DigitalPersona Web Components services.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Ticket", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a ticket object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "jwt" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "jwt", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Property", "canonicalReference": "(jwt:instance)", "docComment": "/**\n * A JSON Web Token\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "jwt" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "jwt", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(None:static,0)", "docComment": "/**\n * Creates a ticket with an emtpy token. Used as a placeholder when no token is needed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "None" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "None" } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Url:class)", "docComment": "/**\n * Provides a way to construct sanitized URLs from a base URL, a path and a query object\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Url" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Url", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs an URL object from a base URL, a path and a query object.\n *\n * @remarks\n *\n * The URL is built by concatenation of a base URL with sanitized path and query object, adding all needed delimiters. Example:\n *\n * @param base - base URL, e.g. `https://contoso.com`\n *\n * @param path - optional path, e.g. `api/v1/user`\n *\n * @param query - optional set of query parameters, e.g. `{ name: \"john\", type: \"5\" }`\n *\n * @example\n * ```\n * const url = new Url(\"https://contoso.com\", \"api/v1/user\", { name: \"john\", type: \"5\" });\n * console.log(url.href);\n * > https://contoso.com/api/v1/user?name=john&type=5\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "base" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "path" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "query" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "object | null" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "base", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } }, { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ] }, { "kind": "Method", "canonicalReference": "(create:static,0)", "docComment": "/**\n * Constructs an URL string from a base URL, a path and a query object.\n *\n * @remarks\n *\n * The URL is built by concatenation of a base URL with sanitized path and query object, adding all needed delimiters.\n *\n * @param base - base URL, e.g. `https://contoso.com`\n *\n * @param path - optional path, e.g. `api/v1/user`\n *\n * @param query - optional set of query parameters, e.g. `{ name: \"john\", type: \"5\" }`\n *\n * @example\n * ```typescript\n * const href = Url.create(\"https://contoso.com\", \"api/v1/user\", { name: \"john\", type: \"5\" });\n * console.log(href);\n * ```\n *\n * `> https://contoso.com/api/v1/user?name=john&type=5`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "base" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "path" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "query" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "object | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "base", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } }, { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } } ], "name": "create" }, { "kind": "Property", "canonicalReference": "(href:instance)", "docComment": "/**\n * Hyperlink reference\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "href" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "href", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(User:class)", "docComment": "/**\n * Represents a user's identity using a user's name name and a type of the name. This class is typially used to pass a user name during authentication.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "User", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs the object using a username and a user type.\n *\n * @remarks\n *\n * If no `type` parameter is provided, the username format is analyzes and automatic type is assigned. For example: * \"user\\@comtoso.com\" name will be parsed as a {@link UserNameType.UPN | User Principal Name (UPN)}, * \"Domain\\\\UserX\" name will be parsed as a {@link UserNameType.SAM | Security Account Manager (SAM)} name, * \"6de5b5ed-85fc-4298-a18b-dac7d5a18369\" will be parsed as a {@link UserNameType.UID | Unique Identifier (UID)} name, * \"UserX\" name will be parsed as a {@link UserNameType.DP | DigitalPersona name} (used in LDS) You may provide a `type` parameter if you want to enforce a specific name type.\n *\n * @param name - user name. No name transformation/canonicalization is performed.\n *\n * @param type - an optional type of the user. If not provided, he type is deduced automatically.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "UserNameType" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ] }, { "kind": "Method", "canonicalReference": "(Anonymous:static,0)", "docComment": "/**\n * Creates a user object representing an anonymous user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "Anonymous" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "Anonymous" }, { "kind": "Method", "canonicalReference": "(Everyone:static,0)", "docComment": "/**\n * Creates a user object representing every user.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "Everyone" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "Everyone" }, { "kind": "Method", "canonicalReference": "(fromJWT:static,0)", "docComment": "/**\n * Creates a user object using claims in a JSON Web Token.\n *\n * @remarks\n *\n * The `token` should contain either {@link ClaimSet.sub | `sub`} or {@link ClaimSet.wan | `wan`} claim to detect a user name. If no such claims are found, then {@link User.Anonymous | anonymous} user is returned. The {@link ClaimSet.sub | `sub`} claim has a priority over the {@link ClaimSet.wan | `wan`} claim. If `type` parameter is not defined, the name type is deduced automatically from the name string. You may provide a `type` parameter if you want to enforce a specific name type. See {@link User.constructor} for type deduction details.\n *\n * @param token - a JSON Web Token.\n *\n * @param type - an optional username type to override automatic type detection and force a specific name format.\n *\n * @returns a user object constructed from the `token` claims.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromJWT" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "token" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "UserNameType" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "token", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "fromJWT" }, { "kind": "Method", "canonicalReference": "(isAnonymous:instance,0)", "docComment": "/**\n * @returns `true` when the User object represents an anonymous user.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "isAnonymous" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "isAnonymous" }, { "kind": "Method", "canonicalReference": "(isEveryone:instance,0)", "docComment": "/**\n * @returns `true` whrn the user object represents any user.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "isEveryone" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "isEveryone" }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "/**\n * User name. Must be defined in one of supported formats (see {@link UserNameType})\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(type:instance)", "docComment": "/**\n * Format of the user name\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "UserNameType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(UserNameType:enum)", "docComment": "/**\n * Enumerates supported username formats.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "UserNameType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "UserNameType", "members": [ { "kind": "EnumMember", "canonicalReference": "Display", "docComment": "/**\n * A friendly display name, for example, “John Doe”.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Display" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "7" } ], "releaseTag": "Public", "name": "Display", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "DNSDomain", "docComment": "/**\n * A DNS domain name, for example, “thecompany.com”.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DNSDomain" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "DNSDomain", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "DP", "docComment": "/**\n * A user name associated with DigitalPersona identity database (formerly known as \"Altus user\").\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DP" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "9" } ], "releaseTag": "Public", "name": "DP", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "NetBIOSDomain", "docComment": "/**\n * NetBIOS domain name, for example, “THE_COMPANY”.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "NetBIOSDomain" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "NetBIOSDomain", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "SAM", "docComment": "/**\n * A MS Windows account name, e.g “the_company\\jdoe” (domain\\user) or \"the_company\\\" (domain only).\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "SAM" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "3" } ], "releaseTag": "Public", "name": "SAM", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "SID", "docComment": "/**\n * A user SID string, for example, “S-1-5-21-1004”.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "SID" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "8" } ], "releaseTag": "Public", "name": "SID", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Simple", "docComment": "/**\n * The account name format used in Microsoft(r) Windows NT(r) 4.0, for example, “jdoe”.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Simple" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "Simple", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "UID", "docComment": "/**\n * A GUID string, for example, “4fa050f0-f561-11cf-bdd9-00aa003a77b6”.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "UID" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "5" } ], "releaseTag": "Public", "name": "UID", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Unknown", "docComment": "/**\n * A name not associated with any Windows account, to be used for local databases only.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Unknown" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Unknown", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "UPN", "docComment": "/**\n * A user principal name, for example, “jdoe@thecompany.com”.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "UPN" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "6" } ], "releaseTag": "Public", "name": "UPN", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(Utf16:class)", "docComment": "/**\n * Set of converters to UTF16.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Utf16" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Utf16", "members": [ { "kind": "Property", "canonicalReference": "(fromBase64:static)", "docComment": "/**\n * Decodes a Base64-encoded string to a UTF16 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBase64" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBase64", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromBase64Url:static)", "docComment": "/**\n * Decodes a Base64url-encoded string to a UTF16 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBase64Url" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBase64Url", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromUtf8:static)", "docComment": "/**\n * Converts a UTF8 string to a UTF16 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromUtf8" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromUtf8", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(noBom:static)", "docComment": "/**\n * Strips a Byte-Order-Mark (BOM) from the UTF16 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "noBom" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "noBom", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(withBom:static)", "docComment": "/**\n * Appends Byte-Order-Mark (BOM) to the UTF16 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "withBom" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "withBom", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Utf8:class)", "docComment": "/**\n * Set of converters to UTF8.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Utf8" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Utf8", "members": [ { "kind": "Property", "canonicalReference": "(fromBase64:static)", "docComment": "/**\n * Decodes a Base64-encoded string to a UTF8 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBase64" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBase64", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromBase64Url:static)", "docComment": "/**\n * Decodes a Base64url-encoded string to a UTF8 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBase64Url" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBase64Url", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromBytes:static)", "docComment": "/**\n * Converts a byte array to a UTF16 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromBytes" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "bytes" }, { "kind": "Content", "text": ": number[] | " }, { "kind": "Reference", "text": "Uint8Array" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromBytes", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(fromUtf16:static)", "docComment": "/**\n * Converts a UTF16 string to a UTF16 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromUtf16" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fromUtf16", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(noBom:static)", "docComment": "/**\n * Strips a Byte-Order-Mark (BOM) from the UTF8 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "noBom" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "noBom", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(withBom:static)", "docComment": "/**\n * Appends Byte-Order-Mark (BOM) to the UTF8 string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "withBom" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "s" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "withBom", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "isStatic": true } ], "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "Answers", "docComment": "/**\n * A collection on answers to security questions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Answers" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "Answer" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Answers", "typeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "Base32String", "docComment": "/**\n * Branded alias type for Base32-encoded strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Base32String" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "encoding" }, { "kind": "Content", "text": "?: \"base32\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Base32String", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "Base64String", "docComment": "/**\n * Branded alias type for Base64-encoded strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Base64String" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "encoding" }, { "kind": "Content", "text": "?: \"base64\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Base64String", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "Base64UrlString", "docComment": "/**\n * Branded alias type for Base64Url-encoded strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "encoding" }, { "kind": "Content", "text": "?: \"base64url\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Base64UrlString", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "ClaimNames", "docComment": "/**\n * Alias type representing all claim names, as if `type ClaimNames = \"jti\" | \"iss\" | \"iat\" | \"aud\" | ... | \"wan\" | \"t24\";`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "ClaimNames" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " in keyof " }, { "kind": "Reference", "text": "ClaimSet" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "ClaimSet" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "] extends " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": " ? never : " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ";\n}[keyof " }, { "kind": "Reference", "text": "ClaimSet" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ClaimNames", "typeTokenRange": { "startIndex": 3, "endIndex": 18 } }, { "kind": "TypeAlias", "canonicalReference": "CredentialId", "docComment": "/**\n * Branded alias type for credential identifier strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "brand" }, { "kind": "Content", "text": "?: \"dp.core.Credential\";\n " }, { "kind": "Reference", "text": "encoding" }, { "kind": "Content", "text": "?: \"guid\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "CredentialId", "typeTokenRange": { "startIndex": 3, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "Fingers", "docComment": "/**\n * Collection of finger enrollment data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Fingers" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "Finger" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Fingers", "typeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "HexString", "docComment": "/**\n * Branded alias type for Hex-encoded strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "HexString" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "encoding" }, { "kind": "Content", "text": "?: \"hex\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "HexString", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "JSONWebToken", "docComment": "/**\n * Branded alias type for a string representing a JSON Web Token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "encoding" }, { "kind": "Content", "text": "?: \"jwt\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "JSONWebToken", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "QuestionNumber", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "QuestionNumber" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "number & {\n " }, { "kind": "Reference", "text": "brand" }, { "kind": "Content", "text": "?: \"dp.core.Question\";\n " }, { "kind": "Reference", "text": "min" }, { "kind": "Content", "text": "?: 0;\n " }, { "kind": "Reference", "text": "max" }, { "kind": "Content", "text": "?: 103;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "QuestionNumber", "typeTokenRange": { "startIndex": 3, "endIndex": 10 } }, { "kind": "TypeAlias", "canonicalReference": "Questions", "docComment": "/**\n * A collection of security questions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Questions" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "Question" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Questions", "typeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "Utf16String", "docComment": "/**\n * Branded alias type for UTF16-encoded strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Utf16String" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "encoding" }, { "kind": "Content", "text": "?: \"utf16\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Utf16String", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "Utf8String", "docComment": "/**\n * Branded alias type for UTF8-encoded strings.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Utf8String" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "encoding" }, { "kind": "Content", "text": "?: \"utf8\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Utf8String", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } } ] } ] }