reusables

package module
Version: v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Dec 17, 2020 License: BSD-2-Clause Imports: 5 Imported by: 0

README

Reusables

The project is currently in ALPHA status and may change in the next couple of month. It's planned to be marked as stable until 31 Dec 2020!

This repository contains all Go file generated of reusable Protobuf definition files.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Contact_ContactType_name = map[int32]string{
		0: "CONTACT_TYPE_UNSPECIFIED",
		1: "CONTACT_TYPE_UNKNOWN",
		2: "CONTACT_TYPE_EMAIL",
		3: "CONTACT_TYPE_WEBSITE",
		4: "CONTACT_TYPE_PHONE_MAIN",
		5: "CONTACT_TYPE_PHONE_MOBILE",
		6: "CONTACT_TYPE_PHONE_FAX",
	}
	Contact_ContactType_value = map[string]int32{
		"CONTACT_TYPE_UNSPECIFIED":  0,
		"CONTACT_TYPE_UNKNOWN":      1,
		"CONTACT_TYPE_EMAIL":        2,
		"CONTACT_TYPE_WEBSITE":      3,
		"CONTACT_TYPE_PHONE_MAIN":   4,
		"CONTACT_TYPE_PHONE_MOBILE": 5,
		"CONTACT_TYPE_PHONE_FAX":    6,
	}
)

Enum value maps for Contact_ContactType.

View Source
var File_fragoe_reusables_v1_address_proto protoreflect.FileDescriptor
View Source
var File_fragoe_reusables_v1_contact_proto protoreflect.FileDescriptor
View Source
var File_fragoe_reusables_v1_i18n_text_proto protoreflect.FileDescriptor
View Source
var File_fragoe_reusables_v1_picture_link_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Address

type Address struct {

	// Language in which the address is given.
	//
	// The names for country, province and city are different in different languages,
	// so you can have the same address in English and German.
	//
	// Example:
	//  - de: Deutschland / Bayern / München
	//  - en: Germany / Bavaria / Munich
	//  - fr: Allemagne / Bavière / Munich
	//
	// Language Codes
	// --------------
	// Language codes are defined by [ISO 639](https://en.wikipedia.org/wiki/ISO_639),
	// an international standard that assigns two- and three-letter codes to most
	// languages of the world.
	//
	// Examples:
	//   - "de"
	//   - "en"
	//   - "fr"
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// The country that this property is located in. The value must be an ISO 3116 uppercase
	// 2-letter country code. For example, United States is "US" and Canada is "CA".
	//
	// reference: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
	Country string `protobuf:"bytes,2,opt,name=country,proto3" json:"country,omitempty"`
	// The name of the property's state, region, or province.
	Province string `protobuf:"bytes,3,opt,name=province,proto3" json:"province,omitempty"`
	// The name of the property's city.
	City string `protobuf:"bytes,4,opt,name=city,proto3" json:"city,omitempty"`
	// The property's postal code.
	PostalCode string `protobuf:"bytes,5,opt,name=postal_code,json=postalCode,proto3" json:"postal_code,omitempty"`
	// The primary street address of the property.
	Address1 string `protobuf:"bytes,6,opt,name=address1,proto3" json:"address1,omitempty"`
	// The secondary street address of the property, if necessary.
	Address2 string `protobuf:"bytes,7,opt,name=address2,proto3" json:"address2,omitempty"`
	// The secondary street address of the property, if necessary.
	Address3 string `protobuf:"bytes,8,opt,name=address3,proto3" json:"address3,omitempty"`
	// contains filtered or unexported fields
}

A full physical location of something.

func (*Address) Descriptor deprecated

This method has been deprecated.
func (*Address) Descriptor() ([]byte, []int)

Deprecated: Use Address.ProtoReflect.Descriptor instead.

func (*Address) GetAddress1

func (x *Address) GetAddress1() string

func (*Address) GetAddress2

func (x *Address) GetAddress2() string

func (*Address) GetAddress3

func (x *Address) GetAddress3() string

func (*Address) GetCity

func (x *Address) GetCity() string

func (*Address) GetCountry

func (x *Address) GetCountry() string

func (*Address) GetLanguage

func (x *Address) GetLanguage() string

func (*Address) GetPostalCode

func (x *Address) GetPostalCode() string

func (*Address) GetProvince

func (x *Address) GetProvince() string

func (*Address) ProtoMessage

func (*Address) ProtoMessage()

func (*Address) ProtoReflect

func (x *Address) ProtoReflect() protoreflect.Message

func (*Address) Reset

func (x *Address) Reset()

func (*Address) String

func (x *Address) String() string

type Contact

type Contact struct {

	// The type of contact (e.g. phone, email).
	Type Contact_ContactType `protobuf:"varint,1,opt,name=type,proto3,enum=fragoe.reusables.v1.Contact_ContactType" json:"type,omitempty"`
	// The contact value, email address, or any kind of identifier.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// Code of the country for which this contact information relevant.
	//
	// Country codes are defined by [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166).
	// It defines two- and three-letter abbreviations for each country or major region
	// in the world. Country codes are set uppercase.
	//
	// Examples:
	//   - "DE"
	//   - "UK"
	Country string `protobuf:"bytes,3,opt,name=country,proto3" json:"country,omitempty"`
	// contains filtered or unexported fields
}

A country specific contact information object.

func (*Contact) Descriptor deprecated

This method has been deprecated.
func (*Contact) Descriptor() ([]byte, []int)

Deprecated: Use Contact.ProtoReflect.Descriptor instead.

func (*Contact) GetCountry

func (x *Contact) GetCountry() string

func (*Contact) GetType

func (x *Contact) GetType() Contact_ContactType

func (*Contact) GetValue

func (x *Contact) GetValue() string

func (*Contact) ProtoMessage

func (*Contact) ProtoMessage()

func (*Contact) ProtoReflect

func (x *Contact) ProtoReflect() protoreflect.Message

func (*Contact) Reset

func (x *Contact) Reset()

func (*Contact) String

func (x *Contact) String() string

type Contact_ContactType

type Contact_ContactType int32

Known contact types.

const (
	Contact_CONTACT_TYPE_UNSPECIFIED  Contact_ContactType = 0
	Contact_CONTACT_TYPE_UNKNOWN      Contact_ContactType = 1
	Contact_CONTACT_TYPE_EMAIL        Contact_ContactType = 2
	Contact_CONTACT_TYPE_WEBSITE      Contact_ContactType = 3
	Contact_CONTACT_TYPE_PHONE_MAIN   Contact_ContactType = 4
	Contact_CONTACT_TYPE_PHONE_MOBILE Contact_ContactType = 5
	Contact_CONTACT_TYPE_PHONE_FAX    Contact_ContactType = 6
)

func (Contact_ContactType) Descriptor

func (Contact_ContactType) Enum

func (Contact_ContactType) EnumDescriptor deprecated

This method has been deprecated.
func (Contact_ContactType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Contact_ContactType.Descriptor instead.

func (Contact_ContactType) Number

func (Contact_ContactType) String

func (x Contact_ContactType) String() string

func (Contact_ContactType) Type

type I18NText

type I18NText struct {

	// Locale, consisting of language and region.
	//
	// Format:
	//     <language code>[_<country code>]
	//
	// Language Codes
	// --------------
	// Language codes are defined by [ISO 639](https://en.wikipedia.org/wiki/ISO_639),
	// an international standard that assigns two- and three-letter codes to most
	// languages of the world. Locale uses the two-letter codes to identify the target
	// language.
	//
	// Country (Region) Codes
	// ----------------------
	// Language doesn't paint the entire picture of a locale. For example, even though
	// you may use de as the locale language code, de alone doesn't tell you anything
	// about where German is spoken. Several countries use German as an official first
	// or even second language in different varieties and dialects. For this reason
	// and others, language is not always sufficient to precisely define a locale.
	//
	// Country codes are defined by [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166),
	// another international standard. It defines two- and three-letter abbreviations
	// for each country or major region in the world. In contrast to the language codes,
	// country codes are set uppercase. Locale uses the two-letter codes instead of the
	// three-letter codes that this standard also defines.
	//
	// Examples:
	//   - de
	//   - de_DE
	//   - de_CH
	Locale string `protobuf:"bytes,1,opt,name=locale,proto3" json:"locale,omitempty"`
	// The text in the specified language.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Internationalised text.

func (*I18NText) Descriptor deprecated

This method has been deprecated.
func (*I18NText) Descriptor() ([]byte, []int)

Deprecated: Use I18NText.ProtoReflect.Descriptor instead.

func (*I18NText) GetLocale

func (x *I18NText) GetLocale() string

func (*I18NText) GetText

func (x *I18NText) GetText() string

func (*I18NText) ProtoMessage

func (*I18NText) ProtoMessage()

func (*I18NText) ProtoReflect

func (x *I18NText) ProtoReflect() protoreflect.Message

func (*I18NText) Reset

func (x *I18NText) Reset()

func (*I18NText) String

func (x *I18NText) String() string
type PictureLink struct {

	// Specifies the location of the picture.
	//
	// The location should be public (not behind a firewall) and should include the
	// protocol (https://).
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// Defines the caption for the picture.
	Caption []*I18NText `protobuf:"bytes,2,rep,name=caption,proto3" json:"caption,omitempty"`
	// contains filtered or unexported fields
}

Object to store a picture URL and an appropriate caption.

func (*PictureLink) Descriptor deprecated

This method has been deprecated.
func (*PictureLink) Descriptor() ([]byte, []int)

Deprecated: Use PictureLink.ProtoReflect.Descriptor instead.

func (*PictureLink) GetCaption

func (x *PictureLink) GetCaption() []*I18NText

func (*PictureLink) GetUrl

func (x *PictureLink) GetUrl() string

func (*PictureLink) ProtoMessage

func (*PictureLink) ProtoMessage()

func (*PictureLink) ProtoReflect

func (x *PictureLink) ProtoReflect() protoreflect.Message

func (*PictureLink) Reset

func (x *PictureLink) Reset()

func (*PictureLink) String

func (x *PictureLink) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL