Ionic Portals

Plugin SDK for Ionic Portals

Install

``bash
npm install @ionic/portals
`

API

* getInitialContext()
* publish(...)
* subscribe(...)
* unsubscribe(...)
* Interfaces

$3

`typescript
getInitialContext() => any
`

Returns: any

--------------------

$3

`typescript
publish(message: PortalMessage) => any
`

| Param | Type |
| ------------- | -------------------------------------------------------------------- |
| message | PortalMessage<TData> |

Returns: any

--------------------

$3

`typescript
subscribe(options: SubscribeOptions, callback: SubscriptionCallback) => any
`

| Param | Type |
| -------------- | ------------------------------------------------------------- |
| options | SubscribeOptions |
| callback | (result: { topic: string; data: T; }) => void |

Returns: any

--------------------

$3

`typescript
unsubscribe(options: PortalSubscription) => any
`

| Param | Type |
| ------------- | ----------------------------------------------------------------- |
| options | PortalSubscription |

Returns: any

--------------------

$3


#### InitialContext

| Prop | Type |
| ------------ | --------------------------------------- |
| name | string |
| value | T |
| assets | { [key: string]: string; } |


#### PortalMessage

| Prop | Type |
| ----------- | ------------------- |
| topic | string |
| data | TData |


#### SubscribeOptions

| Prop | Type |
| ----------- | ------------------- |
| topic | string |


#### PortalSubscription

| Prop | Type |
| --------------------- | ------------------- |
| subscriptionRef | number |
| topic` | string |