Membrane React - v0.6.0
Console
SDK
REST API
Preparing search index...
ExternalEventSubscriptionAccessor
Class ExternalEventSubscriptionAccessor
Index
Constructors
constructor
Methods
get
setup
subscribe
unsubscribe
resubscribe
pull
Events
Constructors
constructor
new
ExternalEventSubscriptionAccessor
(
client
:
MembraneApiClient
,
id
:
string
,
)
:
ExternalEventSubscriptionAccessor
Parameters
client
:
MembraneApiClient
id
:
string
Returns
ExternalEventSubscriptionAccessor
Methods
get
get
()
:
Promise
<
{
id
:
string
;
name
?:
string
;
userId
:
string
;
connectionId
:
string
;
integrationId
:
string
;
config
?:
{
type
:
ExternalEventSubscriptionType
;
dataSource
?:
{
key
?:
string
;
collectionKey
?:
any
;
collectionParameters
?:
any
;
udm
?:
any
;
path
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
}
;
eventKey
?:
string
;
eventParameters
?:
any
;
}
;
status
?:
Subscribed
|
Unsubscribed
|
Error
;
error
?:
ErrorDataSchema
;
isRealTime
?:
boolean
;
requiresPull
?:
boolean
;
requiresFullSync
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
stateData
?:
any
;
nextPullEventsTimestamp
?:
number
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
nextRefreshTimestamp
?:
number
;
globalWebhookKey
?:
string
;
globalWebhookEventSelector
?:
string
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
id
:
string
;
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
}
;
integration
?:
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
}
;
}
,
>
Returns
Promise
<
{
id
:
string
;
name
?:
string
;
userId
:
string
;
connectionId
:
string
;
integrationId
:
string
;
config
?:
{
type
:
ExternalEventSubscriptionType
;
dataSource
?:
{
key
?:
string
;
collectionKey
?:
any
;
collectionParameters
?:
any
;
udm
?:
any
;
path
?:
string
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
}
;
eventKey
?:
string
;
eventParameters
?:
any
;
}
;
status
?:
Subscribed
|
Unsubscribed
|
Error
;
error
?:
ErrorDataSchema
;
isRealTime
?:
boolean
;
requiresPull
?:
boolean
;
requiresFullSync
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
stateData
?:
any
;
nextPullEventsTimestamp
?:
number
;
pullUpdatesIntervalSeconds
?:
number
;
fullSyncIntervalSeconds
?:
number
;
nextRefreshTimestamp
?:
number
;
globalWebhookKey
?:
string
;
globalWebhookEventSelector
?:
string
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
connection
?:
{
id
:
string
;
name
:
string
;
userId
:
string
;
isTest
?:
boolean
;
disconnected
?:
boolean
;
isDefunct
?:
boolean
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
error
?:
ErrorDataSchema
;
integrationId
:
string
;
authOptionKey
?:
string
;
createdAt
:
string
;
updatedAt
:
string
;
lastActiveAt
?:
string
;
nextCredentialsRefreshAt
?:
string
;
archivedAt
?:
string
;
isDeactivated
?:
boolean
;
meta
?:
Record
<
string
,
any
>
;
}
;
integration
?:
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
revision
?:
string
;
createdAt
?:
string
;
updatedAt
?:
string
;
logoUri
:
string
;
connectorId
?:
string
;
connectorVersion
?:
string
;
oAuthCallbackUri
?:
string
;
parameters
?:
any
;
archivedAt
?:
string
;
hasMissingParameters
?:
boolean
;
hasDocumentation
?:
boolean
;
hasOperations
?:
boolean
;
operationsCount
?:
number
;
hasData
?:
boolean
;
dataCollectionsCount
?:
number
;
hasEvents
?:
boolean
;
eventsCount
?:
number
;
hasGlobalWebhooks
?:
boolean
;
hasUdm
?:
boolean
;
isTest
?:
boolean
;
appUuid
?:
string
;
isDeactivated
?:
boolean
;
authType
?:
|
"proxy"
|
"integration-app-token"
|
"membrane-token"
|
"oauth2"
|
"oauth1"
|
"client-credentials"
;
}
;
}
,
>
setup
setup
()
:
Promise
<
void
>
Returns
Promise
<
void
>
subscribe
subscribe
()
:
Promise
<
void
>
Returns
Promise
<
void
>
unsubscribe
unsubscribe
()
:
Promise
<
void
>
Returns
Promise
<
void
>
resubscribe
resubscribe
()
:
Promise
<
void
>
Returns
Promise
<
void
>
pull
Events
pullEvents
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
get
setup
subscribe
unsubscribe
resubscribe
pull
Events
Console
SDK
REST API
Membrane React - v0.6.0
Loading...