models

package
v0.9.0-pre2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2017 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Activity 

type Activity struct {

	// ContactAdded/Removed action
	Action string `json:"action,omitempty"`

	// AttachmentLayout - hint for how to deal with multiple attachments Values: [list|carousel] Default:list
	AttachmentLayout string `json:"attachmentLayout,omitempty"`

	// Attachments
	Attachments []*Attachment `json:"attachments"`

	// Channel specific payload
	ChannelData Object `json:"channelData,omitempty"`

	// ChannelId the activity was on
	ChannelID string `json:"channelId,omitempty"`

	// Conversation
	Conversation *ConversationAccount `json:"conversation,omitempty"`

	// Collection of Entity objects, each of which contains metadata about this activity. Each Entity object is typed.
	Entities []*Entity `json:"entities"`

	// Sender address
	From *ChannelAccount `json:"from,omitempty"`

	// the previous history of the channel was disclosed
	HistoryDisclosed bool `json:"historyDisclosed,omitempty"`

	// Id for the activity
	ID string `json:"id,omitempty"`

	// Local time when message was sent (set by client Ex: 2016-09-23T13:07:49.4714686-07:00)
	LocalTimestamp strfmt.DateTime `json:"localTimestamp,omitempty"`

	// The language code of the Text field
	Locale string `json:"locale,omitempty"`

	// Array of address added
	MembersAdded []*ChannelAccount `json:"membersAdded"`

	// Array of addresses removed
	MembersRemoved []*ChannelAccount `json:"membersRemoved"`

	// (Outbound to bot only) Bot's address that received the message
	Recipient *ChannelAccount `json:"recipient,omitempty"`

	// the original id this message is a response to
	ReplyToID string `json:"replyToId,omitempty"`

	// Service endpoint
	ServiceURL string `json:"serviceUrl,omitempty"`

	// Text to display if you can't render cards
	Summary string `json:"summary,omitempty"`

	// Content for the message
	Text string `json:"text,omitempty"`

	// Format of text fields [plain|markdown] Default:markdown
	TextFormat string `json:"textFormat,omitempty"`

	// UTC Time when message was sent (Set by service)
	Timestamp strfmt.DateTime `json:"timestamp,omitempty"`

	// Conversations new topic name
	TopicName string `json:"topicName,omitempty"`

	// The type of the activity [message|contactRelationUpdate|converationUpdate|typing]
	Type string `json:"type,omitempty"`

	// Open ended value
	Value Object `json:"value,omitempty"`
}

Activity An Activity is the basic communication type for the Bot Framework 3.0 protocol swagger:model Activity

func (*Activity) Validate 

func (m *Activity) Validate(formats strfmt.Registry) error

Validate validates this activity

type AnimationCard 

type AnimationCard struct {

	// Should the client loop playback at end of content (default:true)
	Autoloop bool `json:"autoloop,omitempty"`

	// Should the client automatically start playback of video in this card (default:true)
	Autostart bool `json:"autostart,omitempty"`

	// Set of actions applicable to the current card
	Buttons []*CardAction `json:"buttons"`

	// Thumbnail placeholder
	Image *ThumbnailURL `json:"image,omitempty"`

	// Array of media Url objects
	Media []*MediaURL `json:"media"`

	// Is it OK for this content to be shareable with others (default:true)
	Shareable bool `json:"shareable,omitempty"`

	// Subtitle of the card
	Subtitle string `json:"subtitle,omitempty"`

	// Text of the card
	Text string `json:"text,omitempty"`

	// Title of the card
	Title string `json:"title,omitempty"`
}

AnimationCard An animation card (Ex: gif or short video clip) swagger:model AnimationCard

func (*AnimationCard) Validate 

func (m *AnimationCard) Validate(formats strfmt.Registry) error

Validate validates this animation card

type Attachment 

type Attachment struct {

	// Embedded content
	Content Object `json:"content,omitempty"`

	// mimetype/Contenttype for the file
	ContentType string `json:"contentType,omitempty"`

	// Content Url
	ContentURL string `json:"contentUrl,omitempty"`

	// (OPTIONAL) The name of the attachment
	Name string `json:"name,omitempty"`

	// (OPTIONAL) Thumbnail associated with attachment
	ThumbnailURL string `json:"thumbnailUrl,omitempty"`
}

Attachment An attachment within an activity swagger:model Attachment

func (*Attachment) Validate 

func (m *Attachment) Validate(formats strfmt.Registry) error

Validate validates this attachment

type AttachmentData 

type AttachmentData struct {

	// Name of the attachment
	Name string `json:"name,omitempty"`

	// original content
	OriginalBase64 strfmt.Base64 `json:"originalBase64,omitempty"`

	// Thumbnail
	ThumbnailBase64 strfmt.Base64 `json:"thumbnailBase64,omitempty"`

	// content type of the attachmnet
	Type string `json:"type,omitempty"`
}

AttachmentData Attachment data swagger:model AttachmentData

func (*AttachmentData) Validate 

func (m *AttachmentData) Validate(formats strfmt.Registry) error

Validate validates this attachment data

type AttachmentInfo 

type AttachmentInfo struct {

	// Name of the attachment
	Name string `json:"name,omitempty"`

	// ContentType of the attachment
	Type string `json:"type,omitempty"`

	// attachment views
	Views []*AttachmentView `json:"views"`
}

AttachmentInfo Metdata for an attachment swagger:model AttachmentInfo

func (*AttachmentInfo) Validate 

func (m *AttachmentInfo) Validate(formats strfmt.Registry) error

Validate validates this attachment info

type AttachmentView 

type AttachmentView struct {

	// Name of the attachment
	Size int32 `json:"size,omitempty"`

	// content type of the attachmnet
	ViewID string `json:"viewId,omitempty"`
}

AttachmentView Attachment View name and size swagger:model AttachmentView

func (*AttachmentView) Validate 

func (m *AttachmentView) Validate(formats strfmt.Registry) error

Validate validates this attachment view

type AudioCard 

type AudioCard struct {

	// Aspect ratio of thumbnail/media placeholder, allowed values are "16x9" and "9x16"
	Aspect string `json:"aspect,omitempty"`

	// Should the client loop playback at end of content (default:true)
	Autoloop bool `json:"autoloop,omitempty"`

	// Should the client automatically start playback of video in this card (default:true)
	Autostart bool `json:"autostart,omitempty"`

	// Set of actions applicable to the current card
	Buttons []*CardAction `json:"buttons"`

	// Thumbnail placeholder
	Image *ThumbnailURL `json:"image,omitempty"`

	// Array of media Url objects
	Media []*MediaURL `json:"media"`

	// Is it OK for this content to be shareable with others (default:true)
	Shareable bool `json:"shareable,omitempty"`

	// Subtitle of the card
	Subtitle string `json:"subtitle,omitempty"`

	// Text of the card
	Text string `json:"text,omitempty"`

	// Title of the card
	Title string `json:"title,omitempty"`
}

AudioCard A audio card swagger:model AudioCard

func (*AudioCard) Validate 

func (m *AudioCard) Validate(formats strfmt.Registry) error

Validate validates this audio card

type CardAction 

type CardAction struct {

	// URL Picture which will appear on the button, next to text label.
	Image string `json:"image,omitempty"`

	// Text description which appear on the button.
	Title string `json:"title,omitempty"`

	// Defines the type of action implemented by this button.
	Type string `json:"type,omitempty"`

	// Supplementary parameter for action. Content of this property depends on the ActionType
	Value string `json:"value,omitempty"`
}

CardAction An action on a card swagger:model CardAction

func (*CardAction) Validate 

func (m *CardAction) Validate(formats strfmt.Registry) error

Validate validates this card action

type CardImage 

type CardImage struct {

	// Image description intended for screen readers
	Alt string `json:"alt,omitempty"`

	// Action assigned to specific Attachment.E.g.navigate to specific URL or play/open media content
	Tap *CardAction `json:"tap,omitempty"`

	// URL Thumbnail image for major content property.
	URL string `json:"url,omitempty"`
}

CardImage An image on a card swagger:model CardImage

func (*CardImage) Validate 

func (m *CardImage) Validate(formats strfmt.Registry) error

Validate validates this card image

type ChannelAccount 

type ChannelAccount struct {

	// Channel id for the user or bot on this channel (Example: joe@smith.com, or @joesmith or 123456)
	ID string `json:"id,omitempty"`

	// Display friendly name
	Name string `json:"name,omitempty"`
}

ChannelAccount Channel account information needed to route a message swagger:model ChannelAccount

func (*ChannelAccount) Validate 

func (m *ChannelAccount) Validate(formats strfmt.Registry) error

Validate validates this channel account

type ConversationAccount 

type ConversationAccount struct {

	// Channel id for the user or bot on this channel (Example: joe@smith.com, or @joesmith or 123456)
	ID string `json:"id,omitempty"`

	// Is this a reference to a group
	IsGroup bool `json:"isGroup,omitempty"`

	// Display friendly name
	Name string `json:"name,omitempty"`
}

ConversationAccount Channel account information for a conversation swagger:model ConversationAccount

func (*ConversationAccount) Validate 

func (m *ConversationAccount) Validate(formats strfmt.Registry) error

Validate validates this conversation account

type ConversationParameters 

type ConversationParameters struct {

	// (Optional) When creating a new conversation, use this activity as the intial message to the conversation
	Activity *Activity `json:"activity,omitempty"`

	// The bot address for this conversation
	Bot *ChannelAccount `json:"bot,omitempty"`

	// Channel specific payload
	ChannelData Object `json:"channelData,omitempty"`

	// IsGroup
	IsGroup bool `json:"isGroup,omitempty"`

	// Members to add to the conversation
	Members []*ChannelAccount `json:"members"`

	// (Optional) Topic of the conversation (if supported by the channel)
	TopicName string `json:"topicName,omitempty"`
}

ConversationParameters Parameters for creating a new conversation swagger:model ConversationParameters

func (*ConversationParameters) Validate 

func (m *ConversationParameters) Validate(formats strfmt.Registry) error

Validate validates this conversation parameters

type ConversationResourceResponse 

type ConversationResourceResponse struct {

	// Id of the Activity (if one was created)
	ActivityID string `json:"activityId,omitempty"`

	// Id of the resource
	ID string `json:"id,omitempty"`
}

ConversationResourceResponse A response containing a resource swagger:model ConversationResourceResponse

func (*ConversationResourceResponse) Validate 

func (m *ConversationResourceResponse) Validate(formats strfmt.Registry) error

Validate validates this conversation resource response

type Entity 

type Entity struct {

	// Entity Type (typically from schema.org types)
	Type string `json:"type,omitempty"`
}

Entity Object of schema.org types swagger:model Entity

func (*Entity) Validate 

func (m *Entity) Validate(formats strfmt.Registry) error

Validate validates this entity

type Error 

type Error struct {

	// Error code
	Code string `json:"code,omitempty"`

	// Error message
	Message string `json:"message,omitempty"`
}

Error Object representing error information swagger:model Error

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type ErrorResponse 

type ErrorResponse struct {

	// Error message
	Error *Error `json:"error,omitempty"`
}

ErrorResponse An HTTP API response swagger:model ErrorResponse

func (*ErrorResponse) Validate 

func (m *ErrorResponse) Validate(formats strfmt.Registry) error

Validate validates this error response

type Fact 

type Fact struct {

	// The key for this Fact
	Key string `json:"key,omitempty"`

	// The value for this Fact
	Value string `json:"value,omitempty"`
}

Fact Set of key-value pairs. Advantage of this section is that key and value properties will be 

rendered with default style information with some delimiter between them. So there is no need for developer to specify style information.

swagger:model Fact

func (*Fact) Validate 

func (m *Fact) Validate(formats strfmt.Registry) error

Validate validates this fact

type GeoCoordinates 

type GeoCoordinates struct {

	// Elevation of the location [WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)
	Elevation float64 `json:"elevation,omitempty"`

	// Latitude of the location [WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)
	Latitude float64 `json:"latitude,omitempty"`

	// Longitude of the location [WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)
	Longitude float64 `json:"longitude,omitempty"`

	// The name of the thing
	Name string `json:"name,omitempty"`

	// The type of the thing
	Type string `json:"type,omitempty"`
}

GeoCoordinates GeoCoordinates (entity type: "https://schema.org/GeoCoordinates") swagger:model GeoCoordinates

func (*GeoCoordinates) Validate 

func (m *GeoCoordinates) Validate(formats strfmt.Registry) error

Validate validates this geo coordinates

type HeroCard 

type HeroCard struct {

	// Set of actions applicable to the current card
	Buttons []*CardAction `json:"buttons"`

	// Array of images for the card
	Images []*CardImage `json:"images"`

	// Subtitle of the card
	Subtitle string `json:"subtitle,omitempty"`

	// This action will be activated when user taps on the card itself
	Tap *CardAction `json:"tap,omitempty"`

	// Text for the card
	Text string `json:"text,omitempty"`

	// Title of the card
	Title string `json:"title,omitempty"`
}

HeroCard A Hero card (card with a single, large image) swagger:model HeroCard

func (*HeroCard) Validate 

func (m *HeroCard) Validate(formats strfmt.Registry) error

Validate validates this hero card

type MediaURL 

type MediaURL struct {

	// Optional profile hint to the client to differentiate multiple MediaUrl objects from each other
	Profile string `json:"profile,omitempty"`

	// Url for the media
	URL string `json:"url,omitempty"`
}

MediaURL MediaUrl data swagger:model MediaUrl

func (*MediaURL) Validate 

func (m *MediaURL) Validate(formats strfmt.Registry) error

Validate validates this media Url

type Object 

type Object interface{}

Object object swagger:model Object

type Place 

type Place struct {

	// Address of the place (may be `string` or complex object of type `PostalAddress`)
	Address Object `json:"address,omitempty"`

	// Geo coordinates of the place (may be complex object of type `GeoCoordinates` or `GeoShape`)
	Geo Object `json:"geo,omitempty"`

	// Map to the place (may be `string` (URL) or complex object of type `Map`)
	HasMap Object `json:"hasMap,omitempty"`

	// The name of the thing
	Name string `json:"name,omitempty"`

	// The type of the thing
	Type string `json:"type,omitempty"`
}

Place Place (entity type: "https://schema.org/Place") swagger:model Place

func (*Place) Validate 

func (m *Place) Validate(formats strfmt.Registry) error

Validate validates this place

type ReceiptCard 

type ReceiptCard struct {

	// Set of actions applicable to the current card
	Buttons []*CardAction `json:"buttons"`

	// Array of Fact Objects   Array of key-value pairs.
	Facts []*Fact `json:"facts"`

	// Array of Receipt Items
	Items []*ReceiptItem `json:"items"`

	// This action will be activated when user taps on the card
	Tap *CardAction `json:"tap,omitempty"`

	// Total amount of TAX paid(or should be paid)
	Tax string `json:"tax,omitempty"`

	// Title of the card
	Title string `json:"title,omitempty"`

	// Total amount of money paid (or should be paid)
	Total string `json:"total,omitempty"`

	// Total amount of VAT paid(or should be paid)
	Vat string `json:"vat,omitempty"`
}

ReceiptCard A receipt card swagger:model ReceiptCard

func (*ReceiptCard) Validate 

func (m *ReceiptCard) Validate(formats strfmt.Registry) error

Validate validates this receipt card

type ReceiptItem 

type ReceiptItem struct {

	// Image
	Image *CardImage `json:"image,omitempty"`

	// Amount with currency
	Price string `json:"price,omitempty"`

	// Number of items of given kind
	Quantity string `json:"quantity,omitempty"`

	// Subtitle appears just below Title field, differs from Title in font styling only
	Subtitle string `json:"subtitle,omitempty"`

	// This action will be activated when user taps on the Item bubble.
	Tap *CardAction `json:"tap,omitempty"`

	// Text field appears just below subtitle, differs from Subtitle in font styling only
	Text string `json:"text,omitempty"`

	// Title of the Card
	Title string `json:"title,omitempty"`
}

ReceiptItem An item on a receipt card swagger:model ReceiptItem

func (*ReceiptItem) Validate 

func (m *ReceiptItem) Validate(formats strfmt.Registry) error

Validate validates this receipt item

type ResourceResponse 

type ResourceResponse struct {

	// Id of the resource
	ID string `json:"id,omitempty"`
}

ResourceResponse A response containing a resource ID swagger:model ResourceResponse

func (*ResourceResponse) Validate 

func (m *ResourceResponse) Validate(formats strfmt.Registry) error

Validate validates this resource response

type SigninCard 

type SigninCard struct {

	// Action to use to perform signin
	Buttons []*CardAction `json:"buttons"`

	// Text for signin request
	Text string `json:"text,omitempty"`
}

SigninCard A card representing a request to sign in swagger:model SigninCard

func (*SigninCard) Validate 

func (m *SigninCard) Validate(formats strfmt.Registry) error

Validate validates this signin card

type ThumbnailCard 

type ThumbnailCard struct {

	// Set of actions applicable to the current card
	Buttons []*CardAction `json:"buttons"`

	// Array of images for the card
	Images []*CardImage `json:"images"`

	// Subtitle of the card
	Subtitle string `json:"subtitle,omitempty"`

	// This action will be activated when user taps on the card itself
	Tap *CardAction `json:"tap,omitempty"`

	// Text for the card
	Text string `json:"text,omitempty"`

	// Title of the card
	Title string `json:"title,omitempty"`
}

ThumbnailCard A thumbnail card (card with a single, small thumbnail image) swagger:model ThumbnailCard

func (*ThumbnailCard) Validate 

func (m *ThumbnailCard) Validate(formats strfmt.Registry) error

Validate validates this thumbnail card

type ThumbnailURL 

type ThumbnailURL struct {

	// Alt text to display for screen readers on the thumbnail image
	Alt string `json:"alt,omitempty"`

	// url pointing to an thumbnail to use for media content
	URL string `json:"url,omitempty"`
}

ThumbnailURL Object describing a media thumbnail swagger:model ThumbnailUrl

func (*ThumbnailURL) Validate 

func (m *ThumbnailURL) Validate(formats strfmt.Registry) error

Validate validates this thumbnail Url

type VideoCard 

type VideoCard struct {

	// Should the client loop playback at end of content (default:true)
	Autoloop bool `json:"autoloop,omitempty"`

	// Should the client automatically start playback of video in this card (default:true)
	Autostart bool `json:"autostart,omitempty"`

	// Set of actions applicable to the current card
	Buttons []*CardAction `json:"buttons"`

	// Thumbnail placeholder
	Image *ThumbnailURL `json:"image,omitempty"`

	// Array of media Url objects
	Media []*MediaURL `json:"media"`

	// Is it OK for this content to be shareable with others (default:true)
	Shareable bool `json:"shareable,omitempty"`

	// Subtitle of the card
	Subtitle string `json:"subtitle,omitempty"`

	// Text of the card
	Text string `json:"text,omitempty"`

	// Title of the card
	Title string `json:"title,omitempty"`
}

VideoCard A video card swagger:model VideoCard

func (*VideoCard) Validate 

func (m *VideoCard) Validate(formats strfmt.Registry) error

Validate validates this video card

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.