v1

package
v0.0.0-...-586ce9b Latest Latest
Warning

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

 Go to latest Published: Oct 5, 2020 License: Apache-2.0 Imports: 33 Imported by: 0

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_v1_notification_proto protoreflect.FileDescriptor

Functions

func RegisterNotificationServiceHandler 

func RegisterNotificationServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterNotificationServiceHandler registers the http handlers for service NotificationService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterNotificationServiceHandlerClient 

func RegisterNotificationServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client NotificationServiceClient) error

RegisterNotificationServiceHandlerClient registers the http handlers for service NotificationService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "NotificationServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "NotificationServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "NotificationServiceClient" to call the correct interceptors.

func RegisterNotificationServiceHandlerFromEndpoint 

func RegisterNotificationServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterNotificationServiceHandlerFromEndpoint is same as RegisterNotificationServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterNotificationServiceHandlerServer 

func RegisterNotificationServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server NotificationServiceServer) error

RegisterNotificationServiceHandlerServer registers the http handlers for service NotificationService to "mux". UnaryRPC :call NotificationServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterNotificationServiceHandlerFromEndpoint instead.

func RegisterNotificationServiceServer 

func RegisterNotificationServiceServer(s *grpc.Server, srv NotificationServiceServer)

Types

type AppInstance 

type AppInstance struct {

	// instance_id is a unique identifier for the user application that's stable.
	// see https://firebase.google.com/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId#getId()
	// @inject_tag: firestore:"instanceID,omitempty"
	InstanceId string `protobuf:"bytes,1,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty" firestore:"instanceID,omitempty"`
	// token is an ephemeral token that is being rotated by Firebase. This field may
	// differ in time for the same instance_id.
	// see https://firebase.google.com/docs/cloud-messaging/android/client#sample-register
	// @inject_tag: firestore:"token,omitempty"
	Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty" firestore:"token,omitempty"`
	// ref is a consumer-defined id used querying the tokens and sending notifications
	// to a specific user or a group of users.
	// Usage:
	//  - use this field to store the unique user ID
	//  - for anonymous users, generate their unique ID from Firebase
	// @inject_tag: firestore:"ref,omitempty"
	Ref string `protobuf:"bytes,3,opt,name=ref,proto3" json:"ref,omitempty" firestore:"ref,omitempty"`
	// labels is a map used for querying using the equality operator. Use this field
	// to group users or add metadata when needed.
	// @inject_tag: firestore:"labels,omitempty"
	Labels map[string]string `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*AppInstance) Descriptor deprecated 

func (*AppInstance) Descriptor() ([]byte, []int)

Deprecated: Use AppInstance.ProtoReflect.Descriptor instead.

func (*AppInstance) GetInstanceId 

func (x *AppInstance) GetInstanceId() string

func (*AppInstance) GetLabels 

func (x *AppInstance) GetLabels() map[string]string

func (*AppInstance) GetRef 

func (x *AppInstance) GetRef() string

func (*AppInstance) GetToken 

func (x *AppInstance) GetToken() string

func (*AppInstance) ProtoMessage 

func (*AppInstance) ProtoMessage()

func (*AppInstance) ProtoReflect 

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

func (*AppInstance) Reset 

func (x *AppInstance) Reset()

func (*AppInstance) String 

func (x *AppInstance) String() string

func (*AppInstance) Validate 

func (m *AppInstance) Validate() error

Validate checks the field values on AppInstance with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type AppInstanceValidationError 

type AppInstanceValidationError struct {
	// contains filtered or unexported fields
}

AppInstanceValidationError is the validation error returned by AppInstance.Validate if the designated constraints aren't met.

func (AppInstanceValidationError) Cause 

func (e AppInstanceValidationError) Cause() error

Cause function returns cause value.

func (AppInstanceValidationError) Error 

func (e AppInstanceValidationError) Error() string

Error satisfies the builtin error interface

func (AppInstanceValidationError) ErrorName 

func (e AppInstanceValidationError) ErrorName() string

ErrorName returns error name.

func (AppInstanceValidationError) Field 

func (e AppInstanceValidationError) Field() string

Field function returns field value.

func (AppInstanceValidationError) Key 

func (e AppInstanceValidationError) Key() bool

Key function returns key value.

func (AppInstanceValidationError) Reason 

func (e AppInstanceValidationError) Reason() string

Reason function returns reason value.

type FCMAPNS 

type FCMAPNS struct {
	// contains filtered or unexported fields
}

func (*FCMAPNS) Descriptor deprecated 

func (*FCMAPNS) Descriptor() ([]byte, []int)

Deprecated: Use FCMAPNS.ProtoReflect.Descriptor instead.

func (*FCMAPNS) ProtoMessage 

func (*FCMAPNS) ProtoMessage()

func (*FCMAPNS) ProtoReflect 

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

func (*FCMAPNS) Reset 

func (x *FCMAPNS) Reset()

func (*FCMAPNS) String 

func (x *FCMAPNS) String() string

func (*FCMAPNS) Validate 

func (m *FCMAPNS) Validate() error

Validate checks the field values on FCMAPNS with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FCMAPNSValidationError 

type FCMAPNSValidationError struct {
	// contains filtered or unexported fields
}

FCMAPNSValidationError is the validation error returned by FCMAPNS.Validate if the designated constraints aren't met.

func (FCMAPNSValidationError) Cause 

func (e FCMAPNSValidationError) Cause() error

Cause function returns cause value.

func (FCMAPNSValidationError) Error 

func (e FCMAPNSValidationError) Error() string

Error satisfies the builtin error interface

func (FCMAPNSValidationError) ErrorName 

func (e FCMAPNSValidationError) ErrorName() string

ErrorName returns error name.

func (FCMAPNSValidationError) Field 

func (e FCMAPNSValidationError) Field() string

Field function returns field value.

func (FCMAPNSValidationError) Key 

func (e FCMAPNSValidationError) Key() bool

Key function returns key value.

func (FCMAPNSValidationError) Reason 

func (e FCMAPNSValidationError) Reason() string

Reason function returns reason value.

type FCMAndroid 

type FCMAndroid struct {
	CollapseKey           string                  `protobuf:"bytes,1,opt,name=collapse_key,json=collapseKey,proto3" json:"collapse_key,omitempty"`
	Priority              string                  `protobuf:"bytes,2,opt,name=priority,proto3" json:"priority,omitempty"`
	Ttl                   *timestamp.Timestamp    `protobuf:"bytes,3,opt,name=ttl,proto3" json:"ttl,omitempty"`
	RestrictedPackageName string                  `` /* 126-byte string literal not displayed */
	Data                  map[string]string       `` /* 149-byte string literal not displayed */
	Notification          *FCMAndroidNotification `protobuf:"bytes,6,opt,name=notification,proto3" json:"notification,omitempty"`
	FcmOptions            *FCMAndroidOptions      `protobuf:"bytes,7,opt,name=fcm_options,json=fcmOptions,proto3" json:"fcm_options,omitempty"`
	// contains filtered or unexported fields
}

see https://pkg.go.dev/firebase.google.com/go/messaging#AndroidConfig

func (*FCMAndroid) Descriptor deprecated 

func (*FCMAndroid) Descriptor() ([]byte, []int)

Deprecated: Use FCMAndroid.ProtoReflect.Descriptor instead.

func (*FCMAndroid) GetCollapseKey 

func (x *FCMAndroid) GetCollapseKey() string

func (*FCMAndroid) GetData 

func (x *FCMAndroid) GetData() map[string]string

func (*FCMAndroid) GetFcmOptions 

func (x *FCMAndroid) GetFcmOptions() *FCMAndroidOptions

func (*FCMAndroid) GetNotification 

func (x *FCMAndroid) GetNotification() *FCMAndroidNotification

func (*FCMAndroid) GetPriority 

func (x *FCMAndroid) GetPriority() string

func (*FCMAndroid) GetRestrictedPackageName 

func (x *FCMAndroid) GetRestrictedPackageName() string

func (*FCMAndroid) GetTtl 

func (x *FCMAndroid) GetTtl() *timestamp.Timestamp

func (*FCMAndroid) ProtoMessage 

func (*FCMAndroid) ProtoMessage()

func (*FCMAndroid) ProtoReflect 

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

func (*FCMAndroid) Reset 

func (x *FCMAndroid) Reset()

func (*FCMAndroid) String 

func (x *FCMAndroid) String() string

func (*FCMAndroid) Validate 

func (m *FCMAndroid) Validate() error

Validate checks the field values on FCMAndroid with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FCMAndroidNotification 

type FCMAndroidNotification struct {

	// @inject_tag: firestore"title,omitempty"
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// @inject_tag: firestore"body,omitempty"
	Body string `protobuf:"bytes,2,opt,name=body,proto3" json:"body,omitempty"`
	// @inject_tag: firestore"icon,omitempty"
	Icon string `protobuf:"bytes,3,opt,name=icon,proto3" json:"icon,omitempty"`
	// @inject_tag: firestore"color,omitempty"
	Color string `protobuf:"bytes,4,opt,name=color,proto3" json:"color,omitempty"`
	// @inject_tag: firestore"sound,omitempty"
	Sound string `protobuf:"bytes,5,opt,name=sound,proto3" json:"sound,omitempty"`
	// @inject_tag: firestore"tag,omitempty"
	Tag string `protobuf:"bytes,6,opt,name=tag,proto3" json:"tag,omitempty"`
	// @inject_tag: firestore"click_action,omitempty"
	ClickAction string `protobuf:"bytes,7,opt,name=click_action,json=clickAction,proto3" json:"click_action,omitempty"`
	// @inject_tag: firestore"body_loc_key,omitempty"
	BodyLocKey string `protobuf:"bytes,8,opt,name=body_loc_key,json=bodyLocKey,proto3" json:"body_loc_key,omitempty"`
	// @inject_tag: firestore"body_loc_args,omitempty"
	BodyLocArgs []string `protobuf:"bytes,9,rep,name=body_loc_args,json=bodyLocArgs,proto3" json:"body_loc_args,omitempty"`
	// @inject_tag: firestore"title_loc_key,omitempty"
	TitleLocKey string `protobuf:"bytes,10,opt,name=title_loc_key,json=titleLocKey,proto3" json:"title_loc_key,omitempty"`
	// @inject_tag: firestore"title_loc_args,omitempty"
	TitleLocArgs []string `protobuf:"bytes,11,rep,name=title_loc_args,json=titleLocArgs,proto3" json:"title_loc_args,omitempty"`
	// @inject_tag: firestore"channel_id,omitempty"
	ChannelId string `protobuf:"bytes,12,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	// @inject_tag: firestore:"image,omitempty" json:"image,omitempty"
	ImageUrl string `protobuf:"bytes,13,opt,name=image_url,json=imageUrl,proto3" json:"image,omitempty" firestore:"image,omitempty"`
	// contains filtered or unexported fields
}

see https://pkg.go.dev/firebase.google.com/go/messaging#AndroidNotification

func (*FCMAndroidNotification) Descriptor deprecated 

func (*FCMAndroidNotification) Descriptor() ([]byte, []int)

Deprecated: Use FCMAndroidNotification.ProtoReflect.Descriptor instead.

func (*FCMAndroidNotification) GetBody 

func (x *FCMAndroidNotification) GetBody() string

func (*FCMAndroidNotification) GetBodyLocArgs 

func (x *FCMAndroidNotification) GetBodyLocArgs() []string

func (*FCMAndroidNotification) GetBodyLocKey 

func (x *FCMAndroidNotification) GetBodyLocKey() string

func (*FCMAndroidNotification) GetChannelId 

func (x *FCMAndroidNotification) GetChannelId() string

func (*FCMAndroidNotification) GetClickAction 

func (x *FCMAndroidNotification) GetClickAction() string

func (*FCMAndroidNotification) GetColor 

func (x *FCMAndroidNotification) GetColor() string

func (*FCMAndroidNotification) GetIcon 

func (x *FCMAndroidNotification) GetIcon() string

func (*FCMAndroidNotification) GetImageUrl 

func (x *FCMAndroidNotification) GetImageUrl() string

func (*FCMAndroidNotification) GetSound 

func (x *FCMAndroidNotification) GetSound() string

func (*FCMAndroidNotification) GetTag 

func (x *FCMAndroidNotification) GetTag() string

func (*FCMAndroidNotification) GetTitle 

func (x *FCMAndroidNotification) GetTitle() string

func (*FCMAndroidNotification) GetTitleLocArgs 

func (x *FCMAndroidNotification) GetTitleLocArgs() []string

func (*FCMAndroidNotification) GetTitleLocKey 

func (x *FCMAndroidNotification) GetTitleLocKey() string

func (*FCMAndroidNotification) ProtoMessage 

func (*FCMAndroidNotification) ProtoMessage()

func (*FCMAndroidNotification) ProtoReflect 

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

func (*FCMAndroidNotification) Reset 

func (x *FCMAndroidNotification) Reset()

func (*FCMAndroidNotification) String 

func (x *FCMAndroidNotification) String() string

func (*FCMAndroidNotification) Validate 

func (m *FCMAndroidNotification) Validate() error

Validate checks the field values on FCMAndroidNotification with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FCMAndroidNotificationValidationError 

type FCMAndroidNotificationValidationError struct {
	// contains filtered or unexported fields
}

FCMAndroidNotificationValidationError is the validation error returned by FCMAndroidNotification.Validate if the designated constraints aren't met.

func (FCMAndroidNotificationValidationError) Cause 

func (e FCMAndroidNotificationValidationError) Cause() error

Cause function returns cause value.

func (FCMAndroidNotificationValidationError) Error 

func (e FCMAndroidNotificationValidationError) Error() string

Error satisfies the builtin error interface

func (FCMAndroidNotificationValidationError) ErrorName 

func (e FCMAndroidNotificationValidationError) ErrorName() string

ErrorName returns error name.

func (FCMAndroidNotificationValidationError) Field 

func (e FCMAndroidNotificationValidationError) Field() string

Field function returns field value.

func (FCMAndroidNotificationValidationError) Key 

func (e FCMAndroidNotificationValidationError) Key() bool

Key function returns key value.

func (FCMAndroidNotificationValidationError) Reason 

func (e FCMAndroidNotificationValidationError) Reason() string

Reason function returns reason value.

type FCMAndroidOptions 

type FCMAndroidOptions struct {

	// @inject_tag: firestore:"analyticsLabel,omitempty"
	AnalyticsLabel string `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

see https://pkg.go.dev/firebase.google.com/go/messaging#AndroidFCMOptions

func (*FCMAndroidOptions) Descriptor deprecated 

func (*FCMAndroidOptions) Descriptor() ([]byte, []int)

Deprecated: Use FCMAndroidOptions.ProtoReflect.Descriptor instead.

func (*FCMAndroidOptions) GetAnalyticsLabel 

func (x *FCMAndroidOptions) GetAnalyticsLabel() string

func (*FCMAndroidOptions) ProtoMessage 

func (*FCMAndroidOptions) ProtoMessage()

func (*FCMAndroidOptions) ProtoReflect 

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

func (*FCMAndroidOptions) Reset 

func (x *FCMAndroidOptions) Reset()

func (*FCMAndroidOptions) String 

func (x *FCMAndroidOptions) String() string

func (*FCMAndroidOptions) Validate 

func (m *FCMAndroidOptions) Validate() error

Validate checks the field values on FCMAndroidOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FCMAndroidOptionsValidationError 

type FCMAndroidOptionsValidationError struct {
	// contains filtered or unexported fields
}

FCMAndroidOptionsValidationError is the validation error returned by FCMAndroidOptions.Validate if the designated constraints aren't met.

func (FCMAndroidOptionsValidationError) Cause 

func (e FCMAndroidOptionsValidationError) Cause() error

Cause function returns cause value.

func (FCMAndroidOptionsValidationError) Error 

func (e FCMAndroidOptionsValidationError) Error() string

Error satisfies the builtin error interface

func (FCMAndroidOptionsValidationError) ErrorName 

func (e FCMAndroidOptionsValidationError) ErrorName() string

ErrorName returns error name.

func (FCMAndroidOptionsValidationError) Field 

func (e FCMAndroidOptionsValidationError) Field() string

Field function returns field value.

func (FCMAndroidOptionsValidationError) Key 

func (e FCMAndroidOptionsValidationError) Key() bool

Key function returns key value.

func (FCMAndroidOptionsValidationError) Reason 

func (e FCMAndroidOptionsValidationError) Reason() string

Reason function returns reason value.

type FCMAndroidValidationError 

type FCMAndroidValidationError struct {
	// contains filtered or unexported fields
}

FCMAndroidValidationError is the validation error returned by FCMAndroid.Validate if the designated constraints aren't met.

func (FCMAndroidValidationError) Cause 

func (e FCMAndroidValidationError) Cause() error

Cause function returns cause value.

func (FCMAndroidValidationError) Error 

func (e FCMAndroidValidationError) Error() string

Error satisfies the builtin error interface

func (FCMAndroidValidationError) ErrorName 

func (e FCMAndroidValidationError) ErrorName() string

ErrorName returns error name.

func (FCMAndroidValidationError) Field 

func (e FCMAndroidValidationError) Field() string

Field function returns field value.

func (FCMAndroidValidationError) Key 

func (e FCMAndroidValidationError) Key() bool

Key function returns key value.

func (FCMAndroidValidationError) Reason 

func (e FCMAndroidValidationError) Reason() string

Reason function returns reason value.

type FCMMessage 

type FCMMessage struct {

	// @inject_tag: firestore:"data,omitempty"
	Data map[string]string `` /* 176-byte string literal not displayed */
	// @inject_tag: firestore:"notification,omitempty"
	Notification *FCMNotification `protobuf:"bytes,2,opt,name=notification,proto3" json:"notification,omitempty" firestore:"notification,omitempty"`
	// @inject_tag: firestore:"android,omitempty"
	Android *FCMAndroid `protobuf:"bytes,3,opt,name=android,proto3" json:"android,omitempty" firestore:"android,omitempty"`
	// @inject_tag: firestore:"webpush,omitempty"
	Webpush *FCMWebpush `protobuf:"bytes,4,opt,name=webpush,proto3" json:"webpush,omitempty" firestore:"webpush,omitempty"`
	// @inject_tag: firestore:"apns,omitempty"
	Apns *FCMAPNS `protobuf:"bytes,5,opt,name=apns,proto3" json:"apns,omitempty" firestore:"apns,omitempty"`
	// @inject_tag: firestore:"fcmOptions,omitempty"
	FcmOptions *FCMOptions `protobuf:"bytes,6,opt,name=fcm_options,json=fcmOptions,proto3" json:"fcm_options,omitempty" firestore:"fcmOptions,omitempty"`
	// @inject_tag: firestore:"token,omitempty"
	Token string `protobuf:"bytes,7,opt,name=token,proto3" json:"token,omitempty" firestore:"token,omitempty"`
	// @inject_tag: firestore:"topic,omitempty"
	Topic string `protobuf:"bytes,8,opt,name=topic,proto3" json:"topic,omitempty" firestore:"topic,omitempty"`
	// @inject_tag: firestore:"condition,omitempty"
	Condition string `protobuf:"bytes,9,opt,name=condition,proto3" json:"condition,omitempty" firestore:"condition,omitempty"`
	// contains filtered or unexported fields
}

func (*FCMMessage) Descriptor deprecated 

func (*FCMMessage) Descriptor() ([]byte, []int)

Deprecated: Use FCMMessage.ProtoReflect.Descriptor instead.

func (*FCMMessage) GetAndroid 

func (x *FCMMessage) GetAndroid() *FCMAndroid

func (*FCMMessage) GetApns 

func (x *FCMMessage) GetApns() *FCMAPNS

func (*FCMMessage) GetCondition 

func (x *FCMMessage) GetCondition() string

func (*FCMMessage) GetData 

func (x *FCMMessage) GetData() map[string]string

func (*FCMMessage) GetFcmOptions 

func (x *FCMMessage) GetFcmOptions() *FCMOptions

func (*FCMMessage) GetNotification 

func (x *FCMMessage) GetNotification() *FCMNotification

func (*FCMMessage) GetToken 

func (x *FCMMessage) GetToken() string

func (*FCMMessage) GetTopic 

func (x *FCMMessage) GetTopic() string

func (*FCMMessage) GetWebpush 

func (x *FCMMessage) GetWebpush() *FCMWebpush

func (*FCMMessage) ProtoMessage 

func (*FCMMessage) ProtoMessage()

func (*FCMMessage) ProtoReflect 

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

func (*FCMMessage) Reset 

func (x *FCMMessage) Reset()

func (*FCMMessage) String 

func (x *FCMMessage) String() string

func (*FCMMessage) Validate 

func (m *FCMMessage) Validate() error

Validate checks the field values on FCMMessage with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FCMMessageValidationError 

type FCMMessageValidationError struct {
	// contains filtered or unexported fields
}

FCMMessageValidationError is the validation error returned by FCMMessage.Validate if the designated constraints aren't met.

func (FCMMessageValidationError) Cause 

func (e FCMMessageValidationError) Cause() error

Cause function returns cause value.

func (FCMMessageValidationError) Error 

func (e FCMMessageValidationError) Error() string

Error satisfies the builtin error interface

func (FCMMessageValidationError) ErrorName 

func (e FCMMessageValidationError) ErrorName() string

ErrorName returns error name.

func (FCMMessageValidationError) Field 

func (e FCMMessageValidationError) Field() string

Field function returns field value.

func (FCMMessageValidationError) Key 

func (e FCMMessageValidationError) Key() bool

Key function returns key value.

func (FCMMessageValidationError) Reason 

func (e FCMMessageValidationError) Reason() string

Reason function returns reason value.

type FCMNotification 

type FCMNotification struct {

	// @inject_tag: firestore:"title,omitempty"
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty" firestore:"title,omitempty"`
	// @inject_tag: firestore:"body,omitempty"
	Body string `protobuf:"bytes,2,opt,name=body,proto3" json:"body,omitempty" firestore:"body,omitempty"`
	// @inject_tag: firestore:"imageURL,omitempty"
	ImageUrl string `protobuf:"bytes,3,opt,name=image_url,json=imageUrl,proto3" json:"image_url,omitempty" firestore:"imageURL,omitempty"`
	// contains filtered or unexported fields
}

func (*FCMNotification) Descriptor deprecated 

func (*FCMNotification) Descriptor() ([]byte, []int)

Deprecated: Use FCMNotification.ProtoReflect.Descriptor instead.

func (*FCMNotification) GetBody 

func (x *FCMNotification) GetBody() string

func (*FCMNotification) GetImageUrl 

func (x *FCMNotification) GetImageUrl() string

func (*FCMNotification) GetTitle 

func (x *FCMNotification) GetTitle() string

func (*FCMNotification) ProtoMessage 

func (*FCMNotification) ProtoMessage()

func (*FCMNotification) ProtoReflect 

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

func (*FCMNotification) Reset 

func (x *FCMNotification) Reset()

func (*FCMNotification) String 

func (x *FCMNotification) String() string

func (*FCMNotification) Validate 

func (m *FCMNotification) Validate() error

Validate checks the field values on FCMNotification with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FCMNotificationValidationError 

type FCMNotificationValidationError struct {
	// contains filtered or unexported fields
}

FCMNotificationValidationError is the validation error returned by FCMNotification.Validate if the designated constraints aren't met.

func (FCMNotificationValidationError) Cause 

func (e FCMNotificationValidationError) Cause() error

Cause function returns cause value.

func (FCMNotificationValidationError) Error 

func (e FCMNotificationValidationError) Error() string

Error satisfies the builtin error interface

func (FCMNotificationValidationError) ErrorName 

func (e FCMNotificationValidationError) ErrorName() string

ErrorName returns error name.

func (FCMNotificationValidationError) Field 

func (e FCMNotificationValidationError) Field() string

Field function returns field value.

func (FCMNotificationValidationError) Key 

func (e FCMNotificationValidationError) Key() bool

Key function returns key value.

func (FCMNotificationValidationError) Reason 

func (e FCMNotificationValidationError) Reason() string

Reason function returns reason value.

type FCMOptions 

type FCMOptions struct {
	// contains filtered or unexported fields
}

func (*FCMOptions) Descriptor deprecated 

func (*FCMOptions) Descriptor() ([]byte, []int)

Deprecated: Use FCMOptions.ProtoReflect.Descriptor instead.

func (*FCMOptions) ProtoMessage 

func (*FCMOptions) ProtoMessage()

func (*FCMOptions) ProtoReflect 

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

func (*FCMOptions) Reset 

func (x *FCMOptions) Reset()

func (*FCMOptions) String 

func (x *FCMOptions) String() string

func (*FCMOptions) Validate 

func (m *FCMOptions) Validate() error

Validate checks the field values on FCMOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FCMOptionsValidationError 

type FCMOptionsValidationError struct {
	// contains filtered or unexported fields
}

FCMOptionsValidationError is the validation error returned by FCMOptions.Validate if the designated constraints aren't met.

func (FCMOptionsValidationError) Cause 

func (e FCMOptionsValidationError) Cause() error

Cause function returns cause value.

func (FCMOptionsValidationError) Error 

func (e FCMOptionsValidationError) Error() string

Error satisfies the builtin error interface

func (FCMOptionsValidationError) ErrorName 

func (e FCMOptionsValidationError) ErrorName() string

ErrorName returns error name.

func (FCMOptionsValidationError) Field 

func (e FCMOptionsValidationError) Field() string

Field function returns field value.

func (FCMOptionsValidationError) Key 

func (e FCMOptionsValidationError) Key() bool

Key function returns key value.

func (FCMOptionsValidationError) Reason 

func (e FCMOptionsValidationError) Reason() string

Reason function returns reason value.

type FCMWebpush 

type FCMWebpush struct {
	// contains filtered or unexported fields
}

func (*FCMWebpush) Descriptor deprecated 

func (*FCMWebpush) Descriptor() ([]byte, []int)

Deprecated: Use FCMWebpush.ProtoReflect.Descriptor instead.

func (*FCMWebpush) ProtoMessage 

func (*FCMWebpush) ProtoMessage()

func (*FCMWebpush) ProtoReflect 

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

func (*FCMWebpush) Reset 

func (x *FCMWebpush) Reset()

func (*FCMWebpush) String 

func (x *FCMWebpush) String() string

func (*FCMWebpush) Validate 

func (m *FCMWebpush) Validate() error

Validate checks the field values on FCMWebpush with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FCMWebpushValidationError 

type FCMWebpushValidationError struct {
	// contains filtered or unexported fields
}

FCMWebpushValidationError is the validation error returned by FCMWebpush.Validate if the designated constraints aren't met.

func (FCMWebpushValidationError) Cause 

func (e FCMWebpushValidationError) Cause() error

Cause function returns cause value.

func (FCMWebpushValidationError) Error 

func (e FCMWebpushValidationError) Error() string

Error satisfies the builtin error interface

func (FCMWebpushValidationError) ErrorName 

func (e FCMWebpushValidationError) ErrorName() string

ErrorName returns error name.

func (FCMWebpushValidationError) Field 

func (e FCMWebpushValidationError) Field() string

Field function returns field value.

func (FCMWebpushValidationError) Key 

func (e FCMWebpushValidationError) Key() bool

Key function returns key value.

func (FCMWebpushValidationError) Reason 

func (e FCMWebpushValidationError) Reason() string

Reason function returns reason value.

type ListNotificationsRequest 

type ListNotificationsRequest struct {

	// the filter accepts parameters using the following rule:
	// 1) if 'instance_id' is set, use this parameter
	// 2) if 'token' is set, use this parameter
	// 3) if 'ref' is set, use this parameter
	// -- parameters 1-3 are always uniquely identifying the objects
	// 4) use labels map with the AND semantic
	Filter    *AppInstance `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	PageSize  int32        `protobuf:"varint,10,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	PageToken string       `protobuf:"bytes,11,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

ListNotificationsRequest defines a message that returns notifications already sent in a descending list

func (*ListNotificationsRequest) Descriptor deprecated 

func (*ListNotificationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationsRequest.ProtoReflect.Descriptor instead.

func (*ListNotificationsRequest) GetFilter 

func (x *ListNotificationsRequest) GetFilter() *AppInstance

func (*ListNotificationsRequest) GetPageSize 

func (x *ListNotificationsRequest) GetPageSize() int32

func (*ListNotificationsRequest) GetPageToken 

func (x *ListNotificationsRequest) GetPageToken() string

func (*ListNotificationsRequest) ProtoMessage 

func (*ListNotificationsRequest) ProtoMessage()

func (*ListNotificationsRequest) ProtoReflect 

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

func (*ListNotificationsRequest) Reset 

func (x *ListNotificationsRequest) Reset()

func (*ListNotificationsRequest) String 

func (x *ListNotificationsRequest) String() string

func (*ListNotificationsRequest) Validate 

func (m *ListNotificationsRequest) Validate() error

Validate checks the field values on ListNotificationsRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ListNotificationsRequestValidationError 

type ListNotificationsRequestValidationError struct {
	// contains filtered or unexported fields
}

ListNotificationsRequestValidationError is the validation error returned by ListNotificationsRequest.Validate if the designated constraints aren't met.

func (ListNotificationsRequestValidationError) Cause 

func (e ListNotificationsRequestValidationError) Cause() error

Cause function returns cause value.

func (ListNotificationsRequestValidationError) Error 

func (e ListNotificationsRequestValidationError) Error() string

Error satisfies the builtin error interface

func (ListNotificationsRequestValidationError) ErrorName 

func (e ListNotificationsRequestValidationError) ErrorName() string

ErrorName returns error name.

func (ListNotificationsRequestValidationError) Field 

func (e ListNotificationsRequestValidationError) Field() string

Field function returns field value.

func (ListNotificationsRequestValidationError) Key 

func (e ListNotificationsRequestValidationError) Key() bool

Key function returns key value.

func (ListNotificationsRequestValidationError) Reason 

func (e ListNotificationsRequestValidationError) Reason() string

Reason function returns reason value.

type Message 

type Message struct {
	TemplateId string `protobuf:"bytes,1,opt,name=template_id,json=templateId,proto3" json:"template_id,omitempty"`
	// templateData is used to replace dynamic values inside the
	// FCM message configuration
	TemplateData map[string]string `` /* 165-byte string literal not displayed */
	// data is the list to be sent along the notification
	Data map[string]string `` /* 149-byte string literal not displayed */
	// the message must specify exactly one of token, topic, or condition
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Client.Send
	Token     string `protobuf:"bytes,4,opt,name=token,proto3" json:"token,omitempty"`
	Topic     string `protobuf:"bytes,5,opt,name=topic,proto3" json:"topic,omitempty"`
	Condition string `protobuf:"bytes,6,opt,name=condition,proto3" json:"condition,omitempty"`
	// contains filtered or unexported fields
}

func (*Message) Descriptor deprecated 

func (*Message) Descriptor() ([]byte, []int)

Deprecated: Use Message.ProtoReflect.Descriptor instead.

func (*Message) GetCondition 

func (x *Message) GetCondition() string

func (*Message) GetData 

func (x *Message) GetData() map[string]string

func (*Message) GetTemplateData 

func (x *Message) GetTemplateData() map[string]string

func (*Message) GetTemplateId 

func (x *Message) GetTemplateId() string

func (*Message) GetToken 

func (x *Message) GetToken() string

func (*Message) GetTopic 

func (x *Message) GetTopic() string

func (*Message) ProtoMessage 

func (*Message) ProtoMessage()

func (*Message) ProtoReflect 

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

func (*Message) Reset 

func (x *Message) Reset()

func (*Message) String 

func (x *Message) String() string

func (*Message) Validate 

func (m *Message) Validate() error

Validate checks the field values on Message with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type MessageTemplate 

type MessageTemplate struct {

	// id is a unique key under which the template is referenced
	// this field is other referenced as 'instance_id'
	// @inject_tag: firestore:"id,omitempty"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" firestore:"id,omitempty"`
	// message is the object containing the configuration of an FCM message
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Message
	// this object will be parsed from the configuration file directly into the
	// FCM message specification
	// @inject_tag: firestore:"message,omitempty"
	Message map[string]*any.Any `` /* 185-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*MessageTemplate) Descriptor deprecated 

func (*MessageTemplate) Descriptor() ([]byte, []int)

Deprecated: Use MessageTemplate.ProtoReflect.Descriptor instead.

func (*MessageTemplate) GetId 

func (x *MessageTemplate) GetId() string

func (*MessageTemplate) GetMessage 

func (x *MessageTemplate) GetMessage() map[string]*any.Any

func (*MessageTemplate) ProtoMessage 

func (*MessageTemplate) ProtoMessage()

func (*MessageTemplate) ProtoReflect 

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

func (*MessageTemplate) Reset 

func (x *MessageTemplate) Reset()

func (*MessageTemplate) String 

func (x *MessageTemplate) String() string

func (*MessageTemplate) Validate 

func (m *MessageTemplate) Validate() error

Validate checks the field values on MessageTemplate with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type MessageTemplateValidationError 

type MessageTemplateValidationError struct {
	// contains filtered or unexported fields
}

MessageTemplateValidationError is the validation error returned by MessageTemplate.Validate if the designated constraints aren't met.

func (MessageTemplateValidationError) Cause 

func (e MessageTemplateValidationError) Cause() error

Cause function returns cause value.

func (MessageTemplateValidationError) Error 

func (e MessageTemplateValidationError) Error() string

Error satisfies the builtin error interface

func (MessageTemplateValidationError) ErrorName 

func (e MessageTemplateValidationError) ErrorName() string

ErrorName returns error name.

func (MessageTemplateValidationError) Field 

func (e MessageTemplateValidationError) Field() string

Field function returns field value.

func (MessageTemplateValidationError) Key 

func (e MessageTemplateValidationError) Key() bool

Key function returns key value.

func (MessageTemplateValidationError) Reason 

func (e MessageTemplateValidationError) Reason() string

Reason function returns reason value.

type MessageValidationError 

type MessageValidationError struct {
	// contains filtered or unexported fields
}

MessageValidationError is the validation error returned by Message.Validate if the designated constraints aren't met.

func (MessageValidationError) Cause 

func (e MessageValidationError) Cause() error

Cause function returns cause value.

func (MessageValidationError) Error 

func (e MessageValidationError) Error() string

Error satisfies the builtin error interface

func (MessageValidationError) ErrorName 

func (e MessageValidationError) ErrorName() string

ErrorName returns error name.

func (MessageValidationError) Field 

func (e MessageValidationError) Field() string

Field function returns field value.

func (MessageValidationError) Key 

func (e MessageValidationError) Key() bool

Key function returns key value.

func (MessageValidationError) Reason 

func (e MessageValidationError) Reason() string

Reason function returns reason value.

type MulticastMessage 

type MulticastMessage struct {
	TemplateId string `protobuf:"bytes,1,opt,name=template_id,json=templateId,proto3" json:"template_id,omitempty"`
	// templateData is used to replace dynamic values inside the
	// FCM message configuration
	TemplateData map[string]string `` /* 165-byte string literal not displayed */
	// data is the list to be sent along the notification
	Data map[string]string `` /* 149-byte string literal not displayed */
	// tokens is a list of tokens the message should be sent to
	Tokens []string `protobuf:"bytes,4,rep,name=tokens,proto3" json:"tokens,omitempty"`
	// contains filtered or unexported fields
}

func (*MulticastMessage) Descriptor deprecated 

func (*MulticastMessage) Descriptor() ([]byte, []int)

Deprecated: Use MulticastMessage.ProtoReflect.Descriptor instead.

func (*MulticastMessage) GetData 

func (x *MulticastMessage) GetData() map[string]string

func (*MulticastMessage) GetTemplateData 

func (x *MulticastMessage) GetTemplateData() map[string]string

func (*MulticastMessage) GetTemplateId 

func (x *MulticastMessage) GetTemplateId() string

func (*MulticastMessage) GetTokens 

func (x *MulticastMessage) GetTokens() []string

func (*MulticastMessage) ProtoMessage 

func (*MulticastMessage) ProtoMessage()

func (*MulticastMessage) ProtoReflect 

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

func (*MulticastMessage) Reset 

func (x *MulticastMessage) Reset()

func (*MulticastMessage) String 

func (x *MulticastMessage) String() string

func (*MulticastMessage) Validate 

func (m *MulticastMessage) Validate() error

Validate checks the field values on MulticastMessage with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type MulticastMessageValidationError 

type MulticastMessageValidationError struct {
	// contains filtered or unexported fields
}

MulticastMessageValidationError is the validation error returned by MulticastMessage.Validate if the designated constraints aren't met.

func (MulticastMessageValidationError) Cause 

func (e MulticastMessageValidationError) Cause() error

Cause function returns cause value.

func (MulticastMessageValidationError) Error 

func (e MulticastMessageValidationError) Error() string

Error satisfies the builtin error interface

func (MulticastMessageValidationError) ErrorName 

func (e MulticastMessageValidationError) ErrorName() string

ErrorName returns error name.

func (MulticastMessageValidationError) Field 

func (e MulticastMessageValidationError) Field() string

Field function returns field value.

func (MulticastMessageValidationError) Key 

func (e MulticastMessageValidationError) Key() bool

Key function returns key value.

func (MulticastMessageValidationError) Reason 

func (e MulticastMessageValidationError) Reason() string

Reason function returns reason value.

type Notification 

type Notification struct {
	Instance *AppInstance      `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
	Data     map[string]string `` /* 149-byte string literal not displayed */
	// message is the object containing the configuration of an FCM message
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Message
	// this object is already populated from the template and corresponds to
	// what was sent to the FCM API
	Message *FCMMessage `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Notification is message generated by the system for a specific user

func (*Notification) Descriptor deprecated 

func (*Notification) Descriptor() ([]byte, []int)

Deprecated: Use Notification.ProtoReflect.Descriptor instead.

func (*Notification) GetData 

func (x *Notification) GetData() map[string]string

func (*Notification) GetInstance 

func (x *Notification) GetInstance() *AppInstance

func (*Notification) GetMessage 

func (x *Notification) GetMessage() *FCMMessage

func (*Notification) ProtoMessage 

func (*Notification) ProtoMessage()

func (*Notification) ProtoReflect 

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

func (*Notification) Reset 

func (x *Notification) Reset()

func (*Notification) String 

func (x *Notification) String() string

func (*Notification) Validate 

func (m *Notification) Validate() error

Validate checks the field values on Notification with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type NotificationConfig 

type NotificationConfig struct {

	// @inject_tag: firestore:"messages,omitempty"
	Messages []*MessageTemplate `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty" firestore:"messages,omitempty"`
	// contains filtered or unexported fields
}

NotificationConfig is the object of a configuration file parsed from the remote config. It contains all message templates

func (*NotificationConfig) Descriptor deprecated 

func (*NotificationConfig) Descriptor() ([]byte, []int)

Deprecated: Use NotificationConfig.ProtoReflect.Descriptor instead.

func (*NotificationConfig) GetMessages 

func (x *NotificationConfig) GetMessages() []*MessageTemplate

func (*NotificationConfig) ProtoMessage 

func (*NotificationConfig) ProtoMessage()

func (*NotificationConfig) ProtoReflect 

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

func (*NotificationConfig) Reset 

func (x *NotificationConfig) Reset()

func (*NotificationConfig) String 

func (x *NotificationConfig) String() string

func (*NotificationConfig) Validate 

func (m *NotificationConfig) Validate() error

Validate checks the field values on NotificationConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type NotificationConfigValidationError 

type NotificationConfigValidationError struct {
	// contains filtered or unexported fields
}

NotificationConfigValidationError is the validation error returned by NotificationConfig.Validate if the designated constraints aren't met.

func (NotificationConfigValidationError) Cause 

func (e NotificationConfigValidationError) Cause() error

Cause function returns cause value.

func (NotificationConfigValidationError) Error 

func (e NotificationConfigValidationError) Error() string

Error satisfies the builtin error interface

func (NotificationConfigValidationError) ErrorName 

func (e NotificationConfigValidationError) ErrorName() string

ErrorName returns error name.

func (NotificationConfigValidationError) Field 

func (e NotificationConfigValidationError) Field() string

Field function returns field value.

func (NotificationConfigValidationError) Key 

func (e NotificationConfigValidationError) Key() bool

Key function returns key value.

func (NotificationConfigValidationError) Reason 

func (e NotificationConfigValidationError) Reason() string

Reason function returns reason value.

type NotificationList 

type NotificationList struct {
	Notifications []*Notification `protobuf:"bytes,1,rep,name=notifications,proto3" json:"notifications,omitempty"`
	NextPageToken string          `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*NotificationList) Descriptor deprecated 

func (*NotificationList) Descriptor() ([]byte, []int)

Deprecated: Use NotificationList.ProtoReflect.Descriptor instead.

func (*NotificationList) GetNextPageToken 

func (x *NotificationList) GetNextPageToken() string

func (*NotificationList) GetNotifications 

func (x *NotificationList) GetNotifications() []*Notification

func (*NotificationList) ProtoMessage 

func (*NotificationList) ProtoMessage()

func (*NotificationList) ProtoReflect 

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

func (*NotificationList) Reset 

func (x *NotificationList) Reset()

func (*NotificationList) String 

func (x *NotificationList) String() string

func (*NotificationList) Validate 

func (m *NotificationList) Validate() error

Validate checks the field values on NotificationList with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type NotificationListValidationError 

type NotificationListValidationError struct {
	// contains filtered or unexported fields
}

NotificationListValidationError is the validation error returned by NotificationList.Validate if the designated constraints aren't met.

func (NotificationListValidationError) Cause 

func (e NotificationListValidationError) Cause() error

Cause function returns cause value.

func (NotificationListValidationError) Error 

func (e NotificationListValidationError) Error() string

Error satisfies the builtin error interface

func (NotificationListValidationError) ErrorName 

func (e NotificationListValidationError) ErrorName() string

ErrorName returns error name.

func (NotificationListValidationError) Field 

func (e NotificationListValidationError) Field() string

Field function returns field value.

func (NotificationListValidationError) Key 

func (e NotificationListValidationError) Key() bool

Key function returns key value.

func (NotificationListValidationError) Reason 

func (e NotificationListValidationError) Reason() string

Reason function returns reason value.

type NotificationServiceClient 

type NotificationServiceClient interface {
	// PutInstance either adds or patches a unique instance_id within the system with the
	// provided token, ref, and labels.
	// In case of patch, only fields present in the request will be rewritten.
	// Labels are rewritten if present - send the full map in case of patching.
	PutInstance(ctx context.Context, in *AppInstance, opts ...grpc.CallOption) (*empty.Empty, error)
	// RemoveToken removes the token from an existing instance in the system.
	// This disables all notifications sent to the user and will result in warnings in logs.
	// The instance token can be re-registered using PutInstance
	RemoveToken(ctx context.Context, in *RemoveTokenRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// RemoveInstance removes the whole instance from the system. Use this in case the application
	// deleted the previous instance. This method is also usable if you want to force-remove the instance
	// from your system (e.g. during account deletion)
	// see https://firebase.google.com/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId#deleteInstanceId()
	RemoveInstance(ctx context.Context, in *RemoveInstanceRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Send sends a single notification with its data either to a token, topic, or a condition (e.g. more topics)
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Client.Send
	// This is a Pub/Sub optimized endpoint
	Send(ctx context.Context, in *SendRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// SendAll sends multiple notificaitons to different defined tokens, topics, or conditions
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Client.SendAll
	// This is a Pub/Sub optimized endpoint
	SendAll(ctx context.Context, in *SendAllRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// SendMulticast sends the same notification to multiple token targets
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Client.SendMulticast
	// This is a Pub/Sub optimized endpoint
	SendMulticast(ctx context.Context, in *SendMulticastRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// ListNotifications returns list of notifications with a paging token
	ListNotifications(ctx context.Context, in *ListNotificationsRequest, opts ...grpc.CallOption) (*NotificationList, error)
}

NotificationServiceClient is the client API for NotificationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewNotificationServiceClient 

func NewNotificationServiceClient(cc grpc.ClientConnInterface) NotificationServiceClient

type NotificationServiceServer 

type NotificationServiceServer interface {
	// PutInstance either adds or patches a unique instance_id within the system with the
	// provided token, ref, and labels.
	// In case of patch, only fields present in the request will be rewritten.
	// Labels are rewritten if present - send the full map in case of patching.
	PutInstance(context.Context, *AppInstance) (*empty.Empty, error)
	// RemoveToken removes the token from an existing instance in the system.
	// This disables all notifications sent to the user and will result in warnings in logs.
	// The instance token can be re-registered using PutInstance
	RemoveToken(context.Context, *RemoveTokenRequest) (*empty.Empty, error)
	// RemoveInstance removes the whole instance from the system. Use this in case the application
	// deleted the previous instance. This method is also usable if you want to force-remove the instance
	// from your system (e.g. during account deletion)
	// see https://firebase.google.com/docs/reference/android/com/google/firebase/iid/FirebaseInstanceId#deleteInstanceId()
	RemoveInstance(context.Context, *RemoveInstanceRequest) (*empty.Empty, error)
	// Send sends a single notification with its data either to a token, topic, or a condition (e.g. more topics)
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Client.Send
	// This is a Pub/Sub optimized endpoint
	Send(context.Context, *SendRequest) (*empty.Empty, error)
	// SendAll sends multiple notificaitons to different defined tokens, topics, or conditions
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Client.SendAll
	// This is a Pub/Sub optimized endpoint
	SendAll(context.Context, *SendAllRequest) (*empty.Empty, error)
	// SendMulticast sends the same notification to multiple token targets
	// see https://pkg.go.dev/firebase.google.com/go/messaging#Client.SendMulticast
	// This is a Pub/Sub optimized endpoint
	SendMulticast(context.Context, *SendMulticastRequest) (*empty.Empty, error)
	// ListNotifications returns list of notifications with a paging token
	ListNotifications(context.Context, *ListNotificationsRequest) (*NotificationList, error)
	// contains filtered or unexported methods
}

NotificationServiceServer is the server API for NotificationService service. All implementations must embed UnimplementedNotificationServiceServer for forward compatibility

type NotificationValidationError 

type NotificationValidationError struct {
	// contains filtered or unexported fields
}

NotificationValidationError is the validation error returned by Notification.Validate if the designated constraints aren't met.

func (NotificationValidationError) Cause 

func (e NotificationValidationError) Cause() error

Cause function returns cause value.

func (NotificationValidationError) Error 

func (e NotificationValidationError) Error() string

Error satisfies the builtin error interface

func (NotificationValidationError) ErrorName 

func (e NotificationValidationError) ErrorName() string

ErrorName returns error name.

func (NotificationValidationError) Field 

func (e NotificationValidationError) Field() string

Field function returns field value.

func (NotificationValidationError) Key 

func (e NotificationValidationError) Key() bool

Key function returns key value.

func (NotificationValidationError) Reason 

func (e NotificationValidationError) Reason() string

Reason function returns reason value.

type RemoveInstanceRequest 

type RemoveInstanceRequest struct {

	// instance_id is the unique identifier used to identify devices
	InstanceId string `protobuf:"bytes,1,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// contains filtered or unexported fields
}

func (*RemoveInstanceRequest) Descriptor deprecated 

func (*RemoveInstanceRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveInstanceRequest.ProtoReflect.Descriptor instead.

func (*RemoveInstanceRequest) GetInstanceId 

func (x *RemoveInstanceRequest) GetInstanceId() string

func (*RemoveInstanceRequest) ProtoMessage 

func (*RemoveInstanceRequest) ProtoMessage()

func (*RemoveInstanceRequest) ProtoReflect 

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

func (*RemoveInstanceRequest) Reset 

func (x *RemoveInstanceRequest) Reset()

func (*RemoveInstanceRequest) String 

func (x *RemoveInstanceRequest) String() string

func (*RemoveInstanceRequest) Validate 

func (m *RemoveInstanceRequest) Validate() error

Validate checks the field values on RemoveInstanceRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RemoveInstanceRequestValidationError 

type RemoveInstanceRequestValidationError struct {
	// contains filtered or unexported fields
}

RemoveInstanceRequestValidationError is the validation error returned by RemoveInstanceRequest.Validate if the designated constraints aren't met.

func (RemoveInstanceRequestValidationError) Cause 

func (e RemoveInstanceRequestValidationError) Cause() error

Cause function returns cause value.

func (RemoveInstanceRequestValidationError) Error 

func (e RemoveInstanceRequestValidationError) Error() string

Error satisfies the builtin error interface

func (RemoveInstanceRequestValidationError) ErrorName 

func (e RemoveInstanceRequestValidationError) ErrorName() string

ErrorName returns error name.

func (RemoveInstanceRequestValidationError) Field 

func (e RemoveInstanceRequestValidationError) Field() string

Field function returns field value.

func (RemoveInstanceRequestValidationError) Key 

func (e RemoveInstanceRequestValidationError) Key() bool

Key function returns key value.

func (RemoveInstanceRequestValidationError) Reason 

func (e RemoveInstanceRequestValidationError) Reason() string

Reason function returns reason value.

type RemoveTokenRequest 

type RemoveTokenRequest struct {

	// instance_id is the unique identifier used to identify devices
	InstanceId string `protobuf:"bytes,1,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// contains filtered or unexported fields
}

func (*RemoveTokenRequest) Descriptor deprecated 

func (*RemoveTokenRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveTokenRequest.ProtoReflect.Descriptor instead.

func (*RemoveTokenRequest) GetInstanceId 

func (x *RemoveTokenRequest) GetInstanceId() string

func (*RemoveTokenRequest) ProtoMessage 

func (*RemoveTokenRequest) ProtoMessage()

func (*RemoveTokenRequest) ProtoReflect 

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

func (*RemoveTokenRequest) Reset 

func (x *RemoveTokenRequest) Reset()

func (*RemoveTokenRequest) String 

func (x *RemoveTokenRequest) String() string

func (*RemoveTokenRequest) Validate 

func (m *RemoveTokenRequest) Validate() error

Validate checks the field values on RemoveTokenRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RemoveTokenRequestValidationError 

type RemoveTokenRequestValidationError struct {
	// contains filtered or unexported fields
}

RemoveTokenRequestValidationError is the validation error returned by RemoveTokenRequest.Validate if the designated constraints aren't met.

func (RemoveTokenRequestValidationError) Cause 

func (e RemoveTokenRequestValidationError) Cause() error

Cause function returns cause value.

func (RemoveTokenRequestValidationError) Error 

func (e RemoveTokenRequestValidationError) Error() string

Error satisfies the builtin error interface

func (RemoveTokenRequestValidationError) ErrorName 

func (e RemoveTokenRequestValidationError) ErrorName() string

ErrorName returns error name.

func (RemoveTokenRequestValidationError) Field 

func (e RemoveTokenRequestValidationError) Field() string

Field function returns field value.

func (RemoveTokenRequestValidationError) Key 

func (e RemoveTokenRequestValidationError) Key() bool

Key function returns key value.

func (RemoveTokenRequestValidationError) Reason 

func (e RemoveTokenRequestValidationError) Reason() string

Reason function returns reason value.

type SendAllRequest 

type SendAllRequest struct {
	Messages []*Message `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

func (*SendAllRequest) Descriptor deprecated 

func (*SendAllRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendAllRequest.ProtoReflect.Descriptor instead.

func (*SendAllRequest) GetMessages 

func (x *SendAllRequest) GetMessages() []*Message

func (*SendAllRequest) ProtoMessage 

func (*SendAllRequest) ProtoMessage()

func (*SendAllRequest) ProtoReflect 

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

func (*SendAllRequest) Reset 

func (x *SendAllRequest) Reset()

func (*SendAllRequest) String 

func (x *SendAllRequest) String() string

func (*SendAllRequest) Validate 

func (m *SendAllRequest) Validate() error

Validate checks the field values on SendAllRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type SendAllRequestValidationError 

type SendAllRequestValidationError struct {
	// contains filtered or unexported fields
}

SendAllRequestValidationError is the validation error returned by SendAllRequest.Validate if the designated constraints aren't met.

func (SendAllRequestValidationError) Cause 

func (e SendAllRequestValidationError) Cause() error

Cause function returns cause value.

func (SendAllRequestValidationError) Error 

func (e SendAllRequestValidationError) Error() string

Error satisfies the builtin error interface

func (SendAllRequestValidationError) ErrorName 

func (e SendAllRequestValidationError) ErrorName() string

ErrorName returns error name.

func (SendAllRequestValidationError) Field 

func (e SendAllRequestValidationError) Field() string

Field function returns field value.

func (SendAllRequestValidationError) Key 

func (e SendAllRequestValidationError) Key() bool

Key function returns key value.

func (SendAllRequestValidationError) Reason 

func (e SendAllRequestValidationError) Reason() string

Reason function returns reason value.

type SendMulticastRequest 

type SendMulticastRequest struct {
	Message *MulticastMessage `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*SendMulticastRequest) Descriptor deprecated 

func (*SendMulticastRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendMulticastRequest.ProtoReflect.Descriptor instead.

func (*SendMulticastRequest) GetMessage 

func (x *SendMulticastRequest) GetMessage() *MulticastMessage

func (*SendMulticastRequest) ProtoMessage 

func (*SendMulticastRequest) ProtoMessage()

func (*SendMulticastRequest) ProtoReflect 

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

func (*SendMulticastRequest) Reset 

func (x *SendMulticastRequest) Reset()

func (*SendMulticastRequest) String 

func (x *SendMulticastRequest) String() string

func (*SendMulticastRequest) Validate 

func (m *SendMulticastRequest) Validate() error

Validate checks the field values on SendMulticastRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type SendMulticastRequestValidationError 

type SendMulticastRequestValidationError struct {
	// contains filtered or unexported fields
}

SendMulticastRequestValidationError is the validation error returned by SendMulticastRequest.Validate if the designated constraints aren't met.

func (SendMulticastRequestValidationError) Cause 

func (e SendMulticastRequestValidationError) Cause() error

Cause function returns cause value.

func (SendMulticastRequestValidationError) Error 

func (e SendMulticastRequestValidationError) Error() string

Error satisfies the builtin error interface

func (SendMulticastRequestValidationError) ErrorName 

func (e SendMulticastRequestValidationError) ErrorName() string

ErrorName returns error name.

func (SendMulticastRequestValidationError) Field 

func (e SendMulticastRequestValidationError) Field() string

Field function returns field value.

func (SendMulticastRequestValidationError) Key 

func (e SendMulticastRequestValidationError) Key() bool

Key function returns key value.

func (SendMulticastRequestValidationError) Reason 

func (e SendMulticastRequestValidationError) Reason() string

Reason function returns reason value.

type SendRequest 

type SendRequest struct {
	Message *Message `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*SendRequest) Descriptor deprecated 

func (*SendRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendRequest.ProtoReflect.Descriptor instead.

func (*SendRequest) GetMessage 

func (x *SendRequest) GetMessage() *Message

func (*SendRequest) ProtoMessage 

func (*SendRequest) ProtoMessage()

func (*SendRequest) ProtoReflect 

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

func (*SendRequest) Reset 

func (x *SendRequest) Reset()

func (*SendRequest) String 

func (x *SendRequest) String() string

func (*SendRequest) Validate 

func (m *SendRequest) Validate() error

Validate checks the field values on SendRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type SendRequestValidationError 

type SendRequestValidationError struct {
	// contains filtered or unexported fields
}

SendRequestValidationError is the validation error returned by SendRequest.Validate if the designated constraints aren't met.

func (SendRequestValidationError) Cause 

func (e SendRequestValidationError) Cause() error

Cause function returns cause value.

func (SendRequestValidationError) Error 

func (e SendRequestValidationError) Error() string

Error satisfies the builtin error interface

func (SendRequestValidationError) ErrorName 

func (e SendRequestValidationError) ErrorName() string

ErrorName returns error name.

func (SendRequestValidationError) Field 

func (e SendRequestValidationError) Field() string

Field function returns field value.

func (SendRequestValidationError) Key 

func (e SendRequestValidationError) Key() bool

Key function returns key value.

func (SendRequestValidationError) Reason 

func (e SendRequestValidationError) Reason() string

Reason function returns reason value.

type UnimplementedNotificationServiceServer 

type UnimplementedNotificationServiceServer struct {
}

UnimplementedNotificationServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedNotificationServiceServer) ListNotifications 

func (UnimplementedNotificationServiceServer) ListNotifications(context.Context, *ListNotificationsRequest) (*NotificationList, error)

func (UnimplementedNotificationServiceServer) PutInstance 

func (UnimplementedNotificationServiceServer) PutInstance(context.Context, *AppInstance) (*empty.Empty, error)

func (UnimplementedNotificationServiceServer) RemoveInstance 

func (UnimplementedNotificationServiceServer) RemoveInstance(context.Context, *RemoveInstanceRequest) (*empty.Empty, error)

func (UnimplementedNotificationServiceServer) RemoveToken 

func (UnimplementedNotificationServiceServer) RemoveToken(context.Context, *RemoveTokenRequest) (*empty.Empty, error)

func (UnimplementedNotificationServiceServer) Send 

func (UnimplementedNotificationServiceServer) Send(context.Context, *SendRequest) (*empty.Empty, error)

func (UnimplementedNotificationServiceServer) SendAll 

func (UnimplementedNotificationServiceServer) SendAll(context.Context, *SendAllRequest) (*empty.Empty, error)

func (UnimplementedNotificationServiceServer) SendMulticast 

func (UnimplementedNotificationServiceServer) SendMulticast(context.Context, *SendMulticastRequest) (*empty.Empty, error)

type UnsafeNotificationServiceServer 

type UnsafeNotificationServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeNotificationServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NotificationServiceServer will result in compilation errors.

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.