PHP 클래스 rcrowe\Hippy\Client

파일 보기 프로젝트 열기: rcrowe/hippy 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$from Name the message will be sent from.
$room Name or id of the room.
$token Admin or notification token.
$transport rcrowe\Hippy\Transport\TransportInterface

공개 메소드들

메소드 설명
__construct ( rcrowe\Hippy\Transport\TransportInterface $transport ) Create a new instance on the client
getFrom ( ) : string Get who the message will be sent from.
getRoom ( ) : string | integer Get the room the message will be sent to.
getToken ( ) : string Get the token used to authenticate with.
getTransport ( ) : rcrowe\Hippy\Transport\TransportInterface Return the TransportInterface that will actually send the message.
send ( rcrowe\Hippy\Message\SenderInterface $msg ) : void Send a single message or a queue of messages. A queue must implement \Iterator in order to work.
setFrom ( string $from ) : void Set who the message will be sent from.
setRoom ( string $room ) : void Set the room that the message will be sent to.
setToken ( string $token ) : void Set the token used to authenticate with.
setTransport ( rcrowe\Hippy\Transport\TransportInterface $transport ) : void Set the instance of TransportInterface that will actually send the message.

메소드 상세

__construct() 공개 메소드

Create a new instance on the client
public __construct ( rcrowe\Hippy\Transport\TransportInterface $transport )
$transport rcrowe\Hippy\Transport\TransportInterface

getFrom() 공개 메소드

Get who the message will be sent from.
public getFrom ( ) : string
리턴 string

getRoom() 공개 메소드

Get the room the message will be sent to.
public getRoom ( ) : string | integer
리턴 string | integer

getToken() 공개 메소드

Get the token used to authenticate with.
public getToken ( ) : string
리턴 string

getTransport() 공개 메소드

Return the TransportInterface that will actually send the message.
public getTransport ( ) : rcrowe\Hippy\Transport\TransportInterface
리턴 rcrowe\Hippy\Transport\TransportInterface

send() 공개 메소드

Send a single message or a queue of messages. A queue must implement \Iterator in order to work.
public send ( rcrowe\Hippy\Message\SenderInterface $msg ) : void
$msg rcrowe\Hippy\Message\SenderInterface
리턴 void

setFrom() 공개 메소드

Set who the message will be sent from.
public setFrom ( string $from ) : void
$from string Message will be sent by this user.
리턴 void

setRoom() 공개 메소드

Set the room that the message will be sent to.
public setRoom ( string $room ) : void
$room string Room name or id.
리턴 void

setToken() 공개 메소드

Set the token used to authenticate with.
public setToken ( string $token ) : void
$token string API token. See https://{domain}.hipchat.com/admin/api.
리턴 void

setTransport() 공개 메소드

Set the instance of TransportInterface that will actually send the message.
public setTransport ( rcrowe\Hippy\Transport\TransportInterface $transport ) : void
$transport rcrowe\Hippy\Transport\TransportInterface
리턴 void

프로퍼티 상세

$from 보호되어 있는 프로퍼티

Name the message will be sent from.
protected $from

$room 보호되어 있는 프로퍼티

Name or id of the room.
protected $room

$token 보호되어 있는 프로퍼티

Admin or notification token.
protected $token

$transport 보호되어 있는 프로퍼티

protected TransportInterface,rcrowe\Hippy\Transport $transport
리턴 rcrowe\Hippy\Transport\TransportInterface