platform/api/symfony/Component/Webhook/Client/RequestParserInterface.yaml
2024-09-02 10:44:11 -07:00

57 lines
1.3 KiB
YAML

name: RequestParserInterface
class_comment: null
dependencies:
- name: Request
type: class
source: Symfony\Component\HttpFoundation\Request
- name: Response
type: class
source: Symfony\Component\HttpFoundation\Response
- name: RemoteEvent
type: class
source: Symfony\Component\RemoteEvent\RemoteEvent
- name: RejectWebhookException
type: class
source: Symfony\Component\Webhook\Exception\RejectWebhookException
properties: []
methods:
- name: parse
visibility: public
parameters:
- name: request
- name: secret
comment: '# * @author Fabien Potencier <fabien@symfony.com>
# */
# interface RequestParserInterface
# {
# /**
# * Parses an HTTP Request and converts it into a RemoteEvent.
# *
# * @return ?RemoteEvent Returns null if the webhook must be ignored
# *
# * @throws RejectWebhookException When the payload is rejected (signature issue,
parse issue, ...)'
- name: createSuccessfulResponse
visibility: public
parameters: []
comment: null
- name: createRejectedResponse
visibility: public
parameters:
- name: reason
comment: null
traits:
- Symfony\Component\HttpFoundation\Request
- Symfony\Component\HttpFoundation\Response
- Symfony\Component\RemoteEvent\RemoteEvent
- Symfony\Component\Webhook\Exception\RejectWebhookException
interfaces: []