Response

Telegram Bot API Response object

The response contains a JSON object. If 'ok' equals true, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future.

R: Expected result type
ok: Boolean Signals if the request was successful
result: Optional R Contains the response in a type-safely way
description: Optional String A human-readable description of the result
errorCode: Optional Integer Error code

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Response(ok: Boolean, result: Option[R] = None, description: Option[String] = None, errorCode: Option[Int] = None, parameters: Option[ResponseParameters] = None)

ok
Boolean Signals if the request was successful
result
Optional R Contains the response in a type-safely way
description
Optional String A human-readable description of the result
errorCode
Optional Integer Error code

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val description: Option[String]

Optional String A human-readable description of the result
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val errorCode: Option[Int]

Optional Integer Error code
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val ok: Boolean

Boolean Signals if the request was successful
val parameters: Option[ResponseParameters]
val result: Option[R]

Optional R Contains the response in a type-safely way
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package methods

case class Response[R](ok: Boolean, result: Option[R] = None, description: Option[String] = None, errorCode: Option[Int] = None, parameters: Option[ResponseParameters] = None) extends Product with Serializable

Instance Constructors

new Response(ok: Boolean, result: Option[R] = None, description: Option[String] = None, errorCode: Option[Int] = None, parameters: Option[ResponseParameters] = None)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val description: Option[String]

final def eq(arg0: AnyRef): Boolean

val errorCode: Option[Int]

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ok: Boolean

val parameters: Option[ResponseParameters]

val result: Option[R]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped