@hyperbeam/iframe

Index

Type aliases hb.tabs event

Type aliases hb.tabs method

Functions GG

default

Other Type aliases

HyperbeamIFrame

HyperbeamIFrame: { adminToken: string | undefined; tabs: Tabs; userId: string; destroy: any; setPermissions: any; setVolume: any }

Type declaration

adminToken: string | undefined
tabs: Tabs
userId: string
destroy:function
- destroy(): void
- Returns void
setPermissions:function
- setPermissions(userId: string, data: PermissionData): any
- Parameters
  - userId: string
  - data: PermissionData
  Returns any
setVolume:function
- setVolume(volume: number): void
- Parameters
  - volume: number
  Returns void

hb Type aliases

PermissionData

PermissionData: { control_disabled: boolean; idle_timeout: number; priority: number }

Permissions data

Type declaration

control_disabled: boolean
idle_timeout: number
priority: number

hb.tabs Type aliases

Tabs

Tabs: { create: Tabs_create; detectLanguage: Tabs_detectLanguage; discard: Tabs_discard; duplicate: Tabs_duplicate; get: Tabs_get; getZoom: Tabs_getZoom; getZoomSettings: Tabs_getZoomSettings; goBack: Tabs_goBack; goForward: Tabs_goForward; group: Tabs_group; highlight: Tabs_highlight; move: Tabs_move; onActivated: Tabs_onActivated; onCreated: Tabs_onCreated; onHighlighted: Tabs_onHighlighted; onMoved: Tabs_onMoved; onRemoved: Tabs_onRemoved; onReplaced: Tabs_onReplaced; onUpdated: Tabs_onUpdated; onZoomChange: Tabs_onZoomChange; query: Tabs_query; reload: Tabs_reload; remove: Tabs_remove; setZoom: Tabs_setZoom; setZoomSettings: Tabs_setZoomSettings; ungroup: Tabs_ungroup; update: Tabs_update }

Chrome extension tabs API

Type declaration

create: Tabs_create
detectLanguage: Tabs_detectLanguage
discard: Tabs_discard
duplicate: Tabs_duplicate
get: Tabs_get
getZoom: Tabs_getZoom
getZoomSettings: Tabs_getZoomSettings
goBack: Tabs_goBack
goForward: Tabs_goForward
group: Tabs_group
highlight: Tabs_highlight
move: Tabs_move
onActivated: Tabs_onActivated
onCreated: Tabs_onCreated
onHighlighted: Tabs_onHighlighted
onMoved: Tabs_onMoved
onRemoved: Tabs_onRemoved
onReplaced: Tabs_onReplaced
onUpdated: Tabs_onUpdated
onZoomChange: Tabs_onZoomChange
query: Tabs_query
reload: Tabs_reload
remove: Tabs_remove
setZoom: Tabs_setZoom
setZoomSettings: Tabs_setZoomSettings
ungroup: Tabs_ungroup
update: Tabs_update

hb.tabs event Type aliases

Tabs_onActivated

Tabs_onActivated: { addListener: any; removeListener: any }

Listen to Chrome tab activated event

Type declaration

addListener:function
- addListener(callback: (activeInfo: TabActiveInfo) => void): Promise<void>
- Parameters
  - callback: (activeInfo: TabActiveInfo) => void
    - - (activeInfo: TabActiveInfo): void
      - Parameters
        activeInfo: TabActiveInfo
        Returns void
  Returns Promise<void>
removeListener:function
- removeListener(callback: (activeInfo: TabActiveInfo) => void): Promise<void>
- Parameters
  - callback: (activeInfo: TabActiveInfo) => void
    - - (activeInfo: TabActiveInfo): void
      - Parameters
        activeInfo: TabActiveInfo
        Returns void
  Returns Promise<void>

Tabs_onCreated

Tabs_onCreated: { addListener: any; removeListener: any }

Listen to Chrome tab created event

Type declaration

addListener:function
- addListener(callback: (tab: Tab) => void): Promise<void>
- Parameters
  - callback: (tab: Tab) => void
    - - (tab: Tab): void
      - Parameters
        tab: Tab
        Returns void
  Returns Promise<void>
removeListener:function
- removeListener(callback: (tab: Tab) => void): Promise<void>
- Parameters
  - callback: (tab: Tab) => void
    - - (tab: Tab): void
      - Parameters
        tab: Tab
        Returns void
  Returns Promise<void>

Tabs_onHighlighted

Tabs_onHighlighted: { addListener: any; removeListener: any }

Listen to Chrome tab highlighted event

Type declaration

addListener:function
- addListener(callback: (highlightInfo: TabHighlightInfo) => void): Promise<void>
- Parameters
  - callback: (highlightInfo: TabHighlightInfo) => void
    - - (highlightInfo: TabHighlightInfo): void
      - Parameters
        highlightInfo: TabHighlightInfo
        Returns void
  Returns Promise<void>
removeListener:function
- removeListener(callback: (highlightInfo: TabHighlightInfo) => void): Promise<void>
- Parameters
  - callback: (highlightInfo: TabHighlightInfo) => void
    - - (highlightInfo: TabHighlightInfo): void
      - Parameters
        highlightInfo: TabHighlightInfo
        Returns void
  Returns Promise<void>

Tabs_onMoved

Tabs_onMoved: { addListener: any; removeListener: any }

Listen to Chrome tab moved event

Type declaration

addListener:function
- addListener(callback: (tabId: number, moveInfo: TabMoveInfo) => void): Promise<void>
- Parameters
  - callback: (tabId: number, moveInfo: TabMoveInfo) => void
    - - (tabId: number, moveInfo: TabMoveInfo): void
      - Parameters
        tabId: number
        moveInfo: TabMoveInfo
        Returns void
  Returns Promise<void>
removeListener:function
- removeListener(callback: (tabId: number, moveInfo: TabMoveInfo) => void): Promise<void>
- Parameters
  - callback: (tabId: number, moveInfo: TabMoveInfo) => void
    - - (tabId: number, moveInfo: TabMoveInfo): void
      - Parameters
        tabId: number
        moveInfo: TabMoveInfo
        Returns void
  Returns Promise<void>

Tabs_onRemoved

Tabs_onRemoved: { addListener: any; removeListener: any }

Listen to Chrome tab removed event

Type declaration

addListener:function
- addListener(callback: (tabId: number, removeInfo: TabRemoveInfo) => void): Promise<void>
- Parameters
  - callback: (tabId: number, removeInfo: TabRemoveInfo) => void
    - - (tabId: number, removeInfo: TabRemoveInfo): void
      - Parameters
        tabId: number
        removeInfo: TabRemoveInfo
        Returns void
  Returns Promise<void>
removeListener:function
- removeListener(callback: (tabId: number, removeInfo: TabRemoveInfo) => void): Promise<void>
- Parameters
  - callback: (tabId: number, removeInfo: TabRemoveInfo) => void
    - - (tabId: number, removeInfo: TabRemoveInfo): void
      - Parameters
        tabId: number
        removeInfo: TabRemoveInfo
        Returns void
  Returns Promise<void>

Tabs_onReplaced

Tabs_onReplaced: { addListener: any; removeListener: any }

Listen to Chrome tab replaced event

Type declaration

addListener:function
- addListener(callback: (addedTabId: number, removedTabId: number) => void): Promise<void>
- Parameters
  - callback: (addedTabId: number, removedTabId: number) => void
    - - (addedTabId: number, removedTabId: number): void
      - Parameters
        addedTabId: number
        removedTabId: number
        Returns void
  Returns Promise<void>
removeListener:function
- removeListener(callback: (addedTabId: number, removedTabId: number) => void): Promise<void>
- Parameters
  - callback: (addedTabId: number, removedTabId: number) => void
    - - (addedTabId: number, removedTabId: number): void
      - Parameters
        addedTabId: number
        removedTabId: number
        Returns void
  Returns Promise<void>

Tabs_onUpdated

Tabs_onUpdated: { addListener: any; removeListener: any }

Listen to Chrome tab updated event

Type declaration

addListener:function
- addListener(callback: (tabId: number, changeInfo: TabChangeInfo, tab: Tab) => void): Promise<void>
- Parameters
  - callback: (tabId: number, changeInfo: TabChangeInfo, tab: Tab) => void
    - - (tabId: number, changeInfo: TabChangeInfo, tab: Tab): void
      - Parameters
        tabId: number
        changeInfo: TabChangeInfo
        tab: Tab
        Returns void
  Returns Promise<void>
removeListener:function
- removeListener(callback: (tabId: number, changeInfo: TabChangeInfo, tab: Tab) => void): Promise<void>
- Parameters
  - callback: (tabId: number, changeInfo: TabChangeInfo, tab: Tab) => void
    - - (tabId: number, changeInfo: TabChangeInfo, tab: Tab): void
      - Parameters
        tabId: number
        changeInfo: TabChangeInfo
        tab: Tab
        Returns void
  Returns Promise<void>

Tabs_onZoomChange

Tabs_onZoomChange: Listener<chrome.tabs.TabZoomChangeEvent>

Listen to Chrome tab zoomChange event

hb.tabs method Type aliases

Tabs_create

Tabs_create: (createProperties: CreateProperties) => Promise<Tab>

Type declaration

- (createProperties: CreateProperties): Promise<Tab>
- Create a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-create
  
  Parameters
  - createProperties: CreateProperties
  Returns Promise<Tab>

Tabs_detectLanguage

Tabs_detectLanguage: { (): Promise<string>; (tabId: number): Promise<string> }

Type declaration

- (): Promise<string>
- (tabId: number): Promise<string>
- DetectLanguage a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-detectLanguage
  
  Returns Promise<string>
- DetectLanguage a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-detectLanguage
  
  Parameters
  - tabId: number
  Returns Promise<string>

Tabs_discard

Tabs_discard: (tabId?: number) => Promise<Tab>

Type declaration

- (tabId?: number): Promise<Tab>
- Discard a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-discard
  
  Parameters
  - Optional tabId: number
  Returns Promise<Tab>

Tabs_duplicate

Tabs_duplicate: (tabId: number) => Promise<Tab>

Type declaration

- (tabId: number): Promise<Tab>
- Duplicate a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-duplicate
  
  Parameters
  - tabId: number
  Returns Promise<Tab>

Tabs_get

Tabs_get: (tabId: number) => Promise<Tab>

Type declaration

- (tabId: number): Promise<Tab>
- Get a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-get
  
  Parameters
  - tabId: number
  Returns Promise<Tab>

Tabs_getZoom

Tabs_getZoom: { (): Promise<number>; (tabId: number): Promise<number> }

Type declaration

- (): Promise<number>
- (tabId: number): Promise<number>
- GetZoom a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-getZoom
  
  Returns Promise<number>
- GetZoom a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-getZoom
  
  Parameters
  - tabId: number
  Returns Promise<number>

Tabs_getZoomSettings

Tabs_getZoomSettings: { (): Promise<ZoomSettings>; (tabId: number): Promise<ZoomSettings> }

Type declaration

- (): Promise<ZoomSettings>
- (tabId: number): Promise<ZoomSettings>
- GetZoomSettings a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-getZoomSettings
  
  Returns Promise<ZoomSettings>
- GetZoomSettings a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-getZoomSettings
  
  Parameters
  - tabId: number
  Returns Promise<ZoomSettings>

Tabs_goBack

Tabs_goBack: { (): Promise<void>; (tabId: number): Promise<void> }

Type declaration

- (): Promise<void>
- (tabId: number): Promise<void>
- GoBack a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-goBack
  
  Returns Promise<void>
- GoBack a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-goBack
  
  Parameters
  - tabId: number
  Returns Promise<void>

Tabs_goForward

Tabs_goForward: { (): Promise<void>; (tabId: number): Promise<void> }

Type declaration

- (): Promise<void>
- (tabId: number): Promise<void>
- GoForward a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-goForward
  
  Returns Promise<void>
- GoForward a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-goForward
  
  Parameters
  - tabId: number
  Returns Promise<void>

Tabs_group

Tabs_group: (options: GroupOptions) => Promise<number>

Type declaration

- (options: GroupOptions): Promise<number>
- Group a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-group
  
  Parameters
  - options: GroupOptions
  Returns Promise<number>

Tabs_highlight

Tabs_highlight: (highlightInfo: HighlightInfo) => Promise<Window>

Type declaration

- (highlightInfo: HighlightInfo): Promise<Window>
- Highlight a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-highlight
  
  Parameters
  - highlightInfo: HighlightInfo
  Returns Promise<Window>

Tabs_move

Tabs_move: { (tabId: number, moveProperties: MoveProperties): Promise<Tab>; (tabIds: number[], moveProperties: MoveProperties): Promise<Tab> }

Type declaration

- (tabId: number, moveProperties: MoveProperties): Promise<Tab>
- (tabIds: number[], moveProperties: MoveProperties): Promise<Tab>
- Move a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-move
  
  Parameters
  - tabId: number
  - moveProperties: MoveProperties
  Returns Promise<Tab>
- Move a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-move
  
  Parameters
  - tabIds: number[]
  - moveProperties: MoveProperties
  Returns Promise<Tab>

Tabs_query

Tabs_query: (queryInfo: QueryInfo) => Promise<Tab[]>

Type declaration

- (queryInfo: QueryInfo): Promise<Tab[]>
- Query a Chrome tab
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-query
```
const tabs = await hb.tabs.query({})
```
  Parameters
  - queryInfo: QueryInfo
  Returns Promise<Tab[]>

Tabs_reload

Tabs_reload: { (tabId: number, reloadProperties?: ReloadProperties): Promise<void>; (reloadProperties: ReloadProperties): Promise<void>; (): Promise<void> }

Type declaration

- (tabId: number, reloadProperties?: ReloadProperties): Promise<void>
- (reloadProperties: ReloadProperties): Promise<void>
- (): Promise<void>
- Reload a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-reload
  
  Parameters
  - tabId: number
  - Optional reloadProperties: ReloadProperties
  Returns Promise<void>
- Reload a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-reload
  
  Parameters
  - reloadProperties: ReloadProperties
  Returns Promise<void>
- Reload a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-reload
  
  Returns Promise<void>

Tabs_remove

Tabs_remove: { (tabId: number): Promise<void>; (tabIds: number[]): Promise<void> }

Type declaration

- (tabId: number): Promise<void>
- (tabIds: number[]): Promise<void>
- Remove a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-remove
  
  Parameters
  - tabId: number
  Returns Promise<void>
- Remove a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-remove
  
  Parameters
  - tabIds: number[]
  Returns Promise<void>

Tabs_setZoom

Tabs_setZoom: { (zoomFactor: number): Promise<void>; (tabId: number, zoomFactor: number): Promise<void> }

Type declaration

- (zoomFactor: number): Promise<void>
- (tabId: number, zoomFactor: number): Promise<void>
- SetZoom a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-setZoom
  
  Parameters
  - zoomFactor: number
  Returns Promise<void>
- SetZoom a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-setZoom
  
  Parameters
  - tabId: number
  - zoomFactor: number
  Returns Promise<void>

Tabs_setZoomSettings

Tabs_setZoomSettings: { (zoomSettings: ZoomSettings): Promise<void>; (tabId: number, zoomSettings: ZoomSettings): Promise<void> }

Type declaration

- (zoomSettings: ZoomSettings): Promise<void>
- (tabId: number, zoomSettings: ZoomSettings): Promise<void>
- SetZoomSettings a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-setZoomSettings
  
  Parameters
  - zoomSettings: ZoomSettings
  Returns Promise<void>
- SetZoomSettings a Chrome tab
  
  See also https://developer.chrome.come/docs/extensions/reference/tabs/#method-setZoomSettings
  
  Parameters
  - tabId: number
  - zoomSettings: ZoomSettings
  Returns Promise<void>

Tabs_ungroup

Tabs_ungroup: (tabIds: number | number[]) => Promise<void>

Type declaration

- (tabIds: number | number[]): Promise<void>
- Ungroup Chrome tabs
  
  See also https://developer.chrome.com/docs/extensions/reference/tabs/#method-ungroup
  
  Parameters
  - tabIds: number | number[]
  Returns Promise<void>

Tabs_update

Tabs_update: { (updateProperties: UpdateProperties): Promise<Tab>; (tabId: number, updateProperties: UpdateProperties): Promise<Tab> }

Type declaration

- (updateProperties: UpdateProperties): Promise<Tab>
- (tabId: number, updateProperties: UpdateProperties): Promise<Tab>
- ```
const updatedTab = await hb.tabs.update({url: "https://hyperbeam.dev/"})
```
  See also https://developer.chrome.com/docs/extensions/reference/tabs/#method-update
  Parameters
  - updateProperties: UpdateProperties
  Returns Promise<Tab>
- ```
const updatedTab = await hb.tabs.update(2, {url: "https://hyperbeam.dev/"})
```
  See also https://developer.chrome.com/docs/extensions/reference/tabs/#method-update
  Parameters
  - tabId: number
  - updateProperties: UpdateProperties
  Returns Promise<Tab>

GG Functions

default

default(iframe: HTMLIFrameElement, url: string, opts?: { adminToken?: string; delegateKeyboard?: boolean; timeout?: number }): Promise<HyperbeamIFrame>

Hyperbeam iframe API constructor

import Hyperbeam from "@hyperbeam/iframe"

const hb = await Hyperbeam(
  document.getElementById("iframe"),
  "https://asdfghjkl.hyperbeam.com/foo?token=bar",
  {
    adminToken: "baz",
    delegateKeyboard: true,
  },
)
console.log(hb.userId)
// get tabs
const tabs = await hb.tabs.query({})
// update first tab
await hb.tabs.update(tabs[0].id, {url: "https://hyperbeam.dev/"})

Parameters

iframe: HTMLIFrameElement

iframe element to set up
url: string

Hyperbeam embed URL
Optional opts: { adminToken?: string; delegateKeyboard?: boolean; timeout?: number }

Additional options
- Optional adminToken?: string
- Optional delegateKeyboard?: boolean
- Optional timeout?: number

Returns Promise<HyperbeamIFrame>

Promise that resolves to a Hyperbeam iframe API instance

Index

Type aliases Other

Type aliases hb

Type aliases hb.tabs

Type aliases hb.tabs event

Type aliases hb.tabs method

Functions GG

Other Type aliases

HyperbeamIFrame

Type declaration

adminToken: string | undefined

tabs: Tabs

userId: string

destroy:function

Returns void

setPermissions:function

Parameters

userId: string

data: PermissionData

Returns any

setVolume:function

Parameters

volume: number

Returns void

hb Type aliases

PermissionData

Type declaration

control_disabled: boolean

idle_timeout: number

priority: number

hb.tabs Type aliases

Tabs

Type declaration

create: Tabs_create

detectLanguage: Tabs_detectLanguage

discard: Tabs_discard

duplicate: Tabs_duplicate

get: Tabs_get

getZoom: Tabs_getZoom

getZoomSettings: Tabs_getZoomSettings

goBack: Tabs_goBack

goForward: Tabs_goForward

group: Tabs_group

highlight: Tabs_highlight

move: Tabs_move

onActivated: Tabs_onActivated

onCreated: Tabs_onCreated

onHighlighted: Tabs_onHighlighted

onMoved: Tabs_onMoved

onRemoved: Tabs_onRemoved

onReplaced: Tabs_onReplaced

onUpdated: Tabs_onUpdated

onZoomChange: Tabs_onZoomChange

query: Tabs_query

reload: Tabs_reload

remove: Tabs_remove

setZoom: Tabs_setZoom

setZoomSettings: Tabs_setZoomSettings

ungroup: Tabs_ungroup

update: Tabs_update

hb.tabs event Type aliases

Tabs_onActivated

Type declaration

addListener:function

Parameters

callback: (activeInfo: TabActiveInfo) => void

Parameters

activeInfo: TabActiveInfo

Returns void

Returns Promise<void>

removeListener:function

Parameters

callback: (activeInfo: TabActiveInfo) => void

Parameters

activeInfo: TabActiveInfo

Returns void

Returns Promise<void>

Tabs_onCreated

Type declaration

addListener:function