arrow-down
    1. Widgets
  1. IAM
    1. Virtual apps
    1. Projects
    2. Layers
        1. AttachmentUploader
        2. Checkbox
        3. Combobox
        4. ContentSelector
        5. ContentTypeFilter
        6. CustomSelector
        7. Date
        8. DateTime
        9. Double
        10. GeoPoint
        11. HtmlArea
        12. ImageSelector
        13. Long
        14. MediaSelector
        15. Radiobutton
        16. Tag
        17. TextArea
        18. TextLine
        19. Time
      1. Field set
      2. Item set
      3. Option set
      4. Mixins
      5. Localization
    3. Content Types
    4. X-data
    5. Macros
    6. Custom styles
    7. Sites
      1. Regions
      2. Part component
      3. Layout component
      4. Text component
      5. Fragments
      6. Filtering
      7. Component indexing
      8. Visual editor
    8. Page templates
    1. Sandboxes
    2. Code
    3. Building
    4. Configuration
    1. Globals
    2. HTTP
    3. Controllers
    4. Filters
    5. Events
    6. Websocket
    7. Error handler
    8. ID provider
    9. Tasks
    10. Localization
    11. Mappings
    12. Components
    13. Processors
    14. Contributions
    15. Templating
    16. Main controller
    17. Java bridge
      1. Webapp Engine
        1. Image service
        2. Component service
      2. Admin Engine
      3. Asset service
      4. HTTP service
      5. IDprovider service
    1. Task engine
    2. Management Endpoint
    3. Statistics Endpoint
    1. Nodes and repos
    2. Properties
    3. Indexing
    4. Branches
    5. Queries (NoQL)
    6. Queries (DSL)
    7. Filters
    8. Aggregations
    9. Highlighting
    10. Editors
    1. Strategies
    2. Distributions
    3. Docker image
    4. Vhosts
    5. Configuration
    6. Backup & restore
    7. Systemd
    8. Clustering
    1. Admin API
    2. Application API
    3. Auditlog API
    4. Authentication API
    5. Cluster API
    6. Common API
    7. Content API
    8. Context API
    9. Event API
    10. Export API
    11. Grid API
    12. I18N API
    13. IO API
    14. Mail API
    15. Node API
    16. Portal API
    17. Project API
    18. Repo API
    19. Scheduler API
    20. Schema API
    21. Tasks API
    22. Value API
    23. VHost API
    24. Websocket API
  2. Audit Logs
    1. Upgrade Notes
    2. Upgrading Apps

Websocket API

Contents

Websocket functions.

Usage

Add the following to your build.gradle file:

dependencies {
  include "com.enonic.xp:lib-websocket:${xpVersion}"
}

Add the import statement to your controller:

import webSocketLib from '/lib/xp/websocket';

You are now ready to use the API.

Functions

addToGroup

Adds an id to a socket group.

Parameters

Name Type Description

group

string

Group name

id

string

Socket id

Returns

void

Example

import {addToGroup} from '/lib/xp/websocket';

addToGroup('people', session.id);

removeFromGroup

Removes an id from a socket group.

Parameters

Name Type Description

group

string

Group name

id

string

Socket id

Returns

void

Example

import {removeFromGroup} from '/lib/xp/websocket';

removeFromGroup('people', session.id);

send

Sends a message directly to a socket id.

Parameters

Name Type Description

id

string

Socket id

message

string

Text message

Returns

void

Example

import {send} from '/lib/xp/websocket';

send(session.id, 'You said - ' + message);

sendToGroup

Sends a message to all sockets in group.

Parameters

Name Type Description

group

string

Group name

message

string

Text message

Returns

void

Example

import {sendToGroup} from '/lib/xp/websocket';

sendToGroup('people', 'Notice this message!');

getGroupSize

XP XP 7.6.0 7.6.0 Gets number of all sockets in a group.

Calculating size of a group has a linear cost from total number of sockets. Consider using this method only if building a message is a resource consuming operation, otherwise it is better to simply sendToGroup.

Parameters

Name Type Description

group

string

Group name

Returns

number

Example

import {getGroupSize} from '/lib/xp/websocket';

getGroupSize('people');

Contents

Contents

AI-powered search

Juke AI