SignalCD Modern PoC API
Preparing search index...
identity/src
IdentityProvider
Interface IdentityProvider
interface
IdentityProvider
{
lookupIdentity
?
(
phoneNumber
:
string
,
sessionToken
:
string
,
)
:
Promise
<
RemoteIdentityPublicMaterial
>
;
lookupKeys
(
phoneNumber
:
string
,
sessionToken
:
string
,
)
:
Promise
<
RemoteIdentityBundle
>
;
register
(
material
:
RegistrationPublicMaterial
,
)
:
Promise
<
RegisteredIdentityClaim
>
;
replenishPrekeys
(
sessionToken
:
string
,
oneTimePrekeys
:
readonly
string
[]
,
)
:
Promise
<
number
>
;
rotateSignedPrekey
(
sessionToken
:
string
,
material
:
SignedPrekeyPublicMaterial
,
)
:
Promise
<
SignedPrekeyRotationClaim
>
;
verifySession
(
sessionToken
:
string
)
:
Promise
<
IdentitySessionClaim
>
;
}
Implemented by
HttpIdentityProvider
Index
Methods
lookup
Identity?
lookup
Keys
register
replenish
Prekeys
rotate
Signed
Prekey
verify
Session
Methods
Optional
lookup
Identity
lookupIdentity
?
(
phoneNumber
:
string
,
sessionToken
:
string
,
)
:
Promise
<
RemoteIdentityPublicMaterial
>
Stable public identity lookup that must not consume a one-time prekey.
Parameters
phoneNumber
:
string
sessionToken
:
string
Returns
Promise
<
RemoteIdentityPublicMaterial
>
lookup
Keys
lookupKeys
(
phoneNumber
:
string
,
sessionToken
:
string
,
)
:
Promise
<
RemoteIdentityBundle
>
Parameters
phoneNumber
:
string
sessionToken
:
string
Returns
Promise
<
RemoteIdentityBundle
>
register
register
(
material
:
RegistrationPublicMaterial
)
:
Promise
<
RegisteredIdentityClaim
>
Parameters
material
:
RegistrationPublicMaterial
Returns
Promise
<
RegisteredIdentityClaim
>
replenish
Prekeys
replenishPrekeys
(
sessionToken
:
string
,
oneTimePrekeys
:
readonly
string
[]
,
)
:
Promise
<
number
>
Parameters
sessionToken
:
string
oneTimePrekeys
:
readonly
string
[]
Returns
Promise
<
number
>
rotate
Signed
Prekey
rotateSignedPrekey
(
sessionToken
:
string
,
material
:
SignedPrekeyPublicMaterial
,
)
:
Promise
<
SignedPrekeyRotationClaim
>
Parameters
sessionToken
:
string
material
:
SignedPrekeyPublicMaterial
Returns
Promise
<
SignedPrekeyRotationClaim
>
verify
Session
verifySession
(
sessionToken
:
string
)
:
Promise
<
IdentitySessionClaim
>
Parameters
sessionToken
:
string
Returns
Promise
<
IdentitySessionClaim
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
lookup
Identity
lookup
Keys
register
replenish
Prekeys
rotate
Signed
Prekey
verify
Session
SignalCD Modern PoC API
Loading...
Stable public identity lookup that must not consume a one-time prekey.