PrivMX DOCS
API Reference/PrivMX Endpoint Web/Core

Connection

Class representing instance of Connection

Methods

getConnectionId

Gets the ID of the current connection.

getConnectionId()

Returns

Promise<number> · ID of the connection

listContexts

Gets a list of Contexts available for the user.

Params

pagingQuery

PagingQuery

with list query parameters

listContexts(pagingQuery)

Returns

Promise<PagingList<Context>> · containing a list of Contexts

listContextUsers

Gets a list of users of given context.

Params

contextId

string

ID of the Context

pagingQuery

PagingQuery

listContextUsers(contextId, pagingQuery)

Returns

Promise<PagingList<UserInfo>> · a list of the UserInfo objects

subscribeFor

Subscribe for the Context events on the given subscription query.

Params

subscriptionQueries

string[]

list of queries

subscribeFor(subscriptionQueries)

Returns

Promise<string[]> · list of subscriptionIds in matching order to subscriptionQueries

unsubscribeFrom

Unsubscribe from events for the given subscriptionId.

Params

subscriptionIds

string[]

list of subscriptionId

unsubscribeFrom(subscriptionIds)

buildSubscriptionQuery

Generate subscription Query for the Context events.

Params

eventType

ConnectionEventType

type of event which you listen for

selectorType

ConnectionEventSelectorType

scope on which you listen for events

selectorId

string

ID of the selector

buildSubscriptionQuery(eventType, selectorType, selectorId)

Returns

Promise<string> · undefined undefined

disconnect

Disconnects from the Platform backend.

disconnect()

setUserVerifier

Sets user's custom verification callback. The feature allows the developer to set up a callback for user verification. A developer can implement an interface and pass the implementation to the function. Each time data is read from the container, a callback will be triggered, allowing the developer to validate the sender in an external service, e.g. Developer's Application Server or PKI Server.

Params

verifier

UserVerifierInterface

an implementation of the UserVerifierInterface

setUserVerifier(verifier)

We use cookies on our website. We use them to ensure the proper functioning of the site and, if you agree, for purposes we set, such as analytics or marketing.