responsetemplate

Documentation

Overview

Package responsetemplate provides basic functionality to handle API response data

Index

• type ResponseTemplate
  • func NewResponseTemplate(raw string) *ResponseTemplate
  • func (rt *ResponseTemplate) GetCode() int
  • func (rt *ResponseTemplate) GetDescription() string
  • func (rt *ResponseTemplate) GetHash() map[string]interface{}
  • func (rt *ResponseTemplate) GetPlain() string
  • func (rt *ResponseTemplate) GetQueuetime() float64
  • func (rt *ResponseTemplate) GetRuntime() float64
  • func (rt *ResponseTemplate) IsError() bool
  • func (rt *ResponseTemplate) IsPending() bool
  • func (rt *ResponseTemplate) IsSuccess() bool
  • func (rt *ResponseTemplate) IsTmpError() bool

Types

type ResponseTemplate

type ResponseTemplate struct {
	Raw  string
	Hash map[string]interface{}
}

ResponseTemplate is a struct used to cover basic functionality to work with API response data (or hardcoded API response data).

func NewResponseTemplate

func NewResponseTemplate(raw string) *ResponseTemplate

NewResponseTemplate represents the constructor for struct ResponseTemplate.

func (*ResponseTemplate) GetCode

func (rt *ResponseTemplate) GetCode() int

GetCode method to return the API response code

func (*ResponseTemplate) GetDescription

func (rt *ResponseTemplate) GetDescription() string

GetDescription method to return the API response description

func (*ResponseTemplate) GetHash

func (rt *ResponseTemplate) GetHash() map[string]interface{}

GetHash method to return API response in hash format

func (*ResponseTemplate) GetPlain

func (rt *ResponseTemplate) GetPlain() string

GetPlain method to return raw API response

func (*ResponseTemplate) GetQueuetime

func (rt *ResponseTemplate) GetQueuetime() float64

GetQueuetime method to return API response queuetime

func (*ResponseTemplate) GetRuntime

func (rt *ResponseTemplate) GetRuntime() float64

GetRuntime method to return API response runtime

func (*ResponseTemplate) IsError

func (rt *ResponseTemplate) IsError() bool

IsError method to check if API response represents an error case

func (*ResponseTemplate) IsPending

func (rt *ResponseTemplate) IsPending() bool

IsPending method to check if current operation is returned as pending

func (*ResponseTemplate) IsSuccess

func (rt *ResponseTemplate) IsSuccess() bool

IsSuccess method to check if API response represents a success case

func (*ResponseTemplate) IsTmpError

func (rt *ResponseTemplate) IsTmpError() bool

IsTmpError method to check if current API response represents a temporary error case