SDK for PHP V3
TransferListenerNotifier
extends AbstractTransferListener
in package
FinalYes
Table of Contents
Constants
- PROGRESS_SNAPSHOT_KEY = 'progress_snapshot'
- REASON_KEY = 'reason'
- REQUEST_ARGS_KEY = 'request_args'
Methods
- __construct() : mixed
- addListener() : void
- bytesTransferred() : bool
- transferComplete() : void
- transferFail() : void
- transferInitiated() : void
Constants
PROGRESS_SNAPSHOT_KEY
public
mixed
PROGRESS_SNAPSHOT_KEY
= 'progress_snapshot'
REASON_KEY
public
mixed
REASON_KEY
= 'reason'
REQUEST_ARGS_KEY
public
mixed
REQUEST_ARGS_KEY
= 'request_args'
Methods
__construct()
public
__construct([array<string|int, mixed> $listeners = [] ]) : mixed
Parameters
- $listeners : array<string|int, mixed> = []
addListener()
public
addListener(AbstractTransferListener $listener) : void
Parameters
- $listener : AbstractTransferListener
bytesTransferred()
public
bytesTransferred(array<string|int, mixed> $context) : bool
Parameters
- $context : array<string|int, mixed>
-
- request_args: (array) The request arguments that will be provided as part of the operation that originated the bytes transferred event.
- progress_snapshot: (TransferProgressSnapshot) The transfer snapshot holder.
Tags
Return values
booltransferComplete()
public
transferComplete(array<string|int, mixed> $context) : void
Parameters
- $context : array<string|int, mixed>
-
- request_args: (array) The request arguments that will be provided as part of the operation that originated the bytes transferred event.
- progress_snapshot: (TransferProgressSnapshot) The transfer snapshot holder.
Tags
transferFail()
public
transferFail(array<string|int, mixed> $context) : void
Parameters
- $context : array<string|int, mixed>
-
- request_args: (array) The request arguments that will be provided as part of the operation that originated the bytes transferred event.
- progress_snapshot: (TransferProgressSnapshot) The transfer snapshot holder.
- reason: (Throwable) The exception originated by the transfer failure.
Tags
transferInitiated()
public
transferInitiated(array<string|int, mixed> $context) : void
Parameters
- $context : array<string|int, mixed>
-
- request_args: (array) The request arguments that will be provided as part of the request initialization.
- progress_snapshot: (TransferProgressSnapshot) The transfer snapshot holder.