# Class: BridgeEvent

## vertx-web-js/bridge_event~ BridgeEvent

#### new BridgeEvent()

Represents an event that occurs on the event bus bridge.

Please consult the documentation for a full explanation.

Source:
  - vertx-web-js/bridge_event.js, line 33

### Methods

#### cause() → {todo}

Source:
  - vertx-web-js/bridge_event.js, line 149

##### Returns:

Type
  todo

#### complete(arg0)

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | boolean |

Source:
  - vertx-web-js/bridge_event.js, line 77

#### completer() → {function}

Source:
  - vertx-web-js/bridge_event.js, line 240

##### Returns:

Type
  function

#### compose(handler, next) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |
`next` | Future |

Source:
  - vertx-web-js/bridge_event.js, line 189

##### Returns:

Type
  Future

#### fail(arg0)

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | string |

Source:
  - vertx-web-js/bridge_event.js, line 91

#### failed() → {boolean}

Source:
  - vertx-web-js/bridge_event.js, line 175

##### Returns:

Type
  boolean

#### getRawMessage() → {Object}

Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved. If the returned message is modified, BridgeEvent#setRawMessage should be called with the new message.

Source:
  - vertx-web-js/bridge_event.js, line 322

##### Returns:

the raw JSON message for the event

Type
  Object

#### isComplete() → {boolean}

Source:
  - vertx-web-js/bridge_event.js, line 45

##### Returns:

Type
  boolean

#### map(value) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`value` | Object |

Source:
  - vertx-web-js/bridge_event.js, line 209

##### Returns:

Type
  Future

#### mapEmpty() → {Future}

Source:
  - vertx-web-js/bridge_event.js, line 227

##### Returns:

Type
  Future

#### otherwise(value) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`value` | boolean |

Source:
  - vertx-web-js/bridge_event.js, line 272

##### Returns:

Type
  Future

#### otherwiseEmpty() → {Future}

Source:
  - vertx-web-js/bridge_event.js, line 290

##### Returns:

Type
  Future

#### recover(mapper) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`mapper` | todo |

Source:
  - vertx-web-js/bridge_event.js, line 256

##### Returns:

Type
  Future

#### result() → {boolean}

Source:
  - vertx-web-js/bridge_event.js, line 136

##### Returns:

Type
  boolean

#### setHandler(arg0) → {Future}

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | function |

Source:
  - vertx-web-js/bridge_event.js, line 58

##### Returns:

Type
  Future

#### setRawMessage(message) → {BridgeEvent}

Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved.

##### Parameters:

Name | Type | Description
--- | --- | ---
`message` | Object | the raw message

Source:
  - vertx-web-js/bridge_event.js, line 337

##### Returns:

this reference, so it can be used fluently

Type
  BridgeEvent

#### socket() → {SockJSSocket}

Get the SockJSSocket instance corresponding to the event

Source:
  - vertx-web-js/bridge_event.js, line 352

##### Returns:

the SockJSSocket instance

Type
  SockJSSocket

#### succeeded() → {boolean}

Source:
  - vertx-web-js/bridge_event.js, line 162

##### Returns:

Type
  boolean

#### tryComplete(arg0) → {boolean}

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | boolean |

Source:
  - vertx-web-js/bridge_event.js, line 106

##### Returns:

Type
  boolean

#### tryFail(arg0) → {boolean}

##### Parameters:

Name | Type | Description
--- | --- | ---
`arg0` | string |

Source:
  - vertx-web-js/bridge_event.js, line 121

##### Returns:

Type
  boolean

#### type() → {Object}

Source:
  - vertx-web-js/bridge_event.js, line 303

##### Returns:

the type of the event

Type
  Object