platform/api/laravel/Contracts/Broadcasting/Broadcaster.yaml

55 lines
976 B
YAML
Raw Normal View History

2024-09-02 17:44:11 +00:00
name: Broadcaster
class_comment: null
dependencies: []
properties: []
methods:
- name: auth
visibility: public
parameters:
- name: request
comment: '# * Authenticate the incoming request for a given channel.
# *
# * @param \Illuminate\Http\Request $request
# * @return mixed'
- name: validAuthenticationResponse
visibility: public
parameters:
- name: request
- name: result
comment: '# * Return the valid authentication response.
# *
# * @param \Illuminate\Http\Request $request
# * @param mixed $result
# * @return mixed'
- name: broadcast
visibility: public
parameters:
- name: channels
- name: event
- name: payload
default: '[]'
comment: '# * Broadcast the given event.
# *
# * @param array $channels
# * @param string $event
# * @param array $payload
# * @return void
# *
# * @throws \Illuminate\Broadcasting\BroadcastException'
traits: []
interfaces: []