Show / Hide Table of Contents

Class Subscription

A subscription to a data collection for a specific user, to be delivered to a subscriber.

Inheritance
object
Subscription
Implements
IMessage<Subscription>
IEquatable<Subscription>
IDeepCloneable<Subscription>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.DevicesAndServices.Health.V4
Assembly: Google.DevicesAndServices.Health.V4.dll
Syntax
public sealed class Subscription : IMessage<Subscription>, IEquatable<Subscription>, IDeepCloneable<Subscription>, IBufferMessage, IMessage

Constructors

Subscription()

Declaration
public Subscription()

Subscription(Subscription)

Declaration
public Subscription(Subscription other)
Parameters
Type Name Description
Subscription other

Properties

DataTypes

Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. Supported data types are: "altitude", "distance", "floors", "sleep", "steps", "weight".

Declaration
public RepeatedField<string> DataTypes { get; }
Property Value
Type Description
RepeatedField<string>

DataTypesAsDataTypeNames

DataTypeName-typed view over the DataTypes resource name property.

Declaration
public ResourceNameList<DataTypeName> DataTypesAsDataTypeNames { get; }
Property Value
Type Description
ResourceNameList<DataTypeName>

Name

Identifier. The resource name of the Subscription. Format: projects/{project}/subscribers/{subscriber}/subscriptions/{subscription} Example: projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456 The {project} ID is mandatory (6-30 characters, matching /[a-z][a-z0-9-]{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /a-z/) or system-generated otherwise.

Declaration
public string Name { get; set; }
Property Value
Type Description
string

SubscriptionName

SubscriptionName-typed view over the Name resource name property.

Declaration
public SubscriptionName SubscriptionName { get; set; }
Property Value
Type Description
SubscriptionName

User

Immutable. The resource name of the user for whom this subscription is active. Format: users/{user} where {user} is the public healthUserId as returned by the GetIdentity action in the profile PAPI (see google.devicesandservices.health.v4main.HealthProfileService.GetIdentity).

Declaration
public string User { get; set; }
Property Value
Type Description
string

UserAsUserName

UserName-typed view over the User resource name property.

Declaration
public UserName UserAsUserName { get; set; }
Property Value
Type Description
UserName
In this article
Back to top Generated by DocFX