Class ProjectsResource.RegistrationsResource.TopicSubscriptionsResource
The "topicSubscriptions" collection of methods.
Inherited Members
Namespace: Google.Apis.FirebaseCloudMessaging.v1
Assembly: Google.Apis.FirebaseCloudMessaging.v1.dll
Syntax
public class ProjectsResource.RegistrationsResource.TopicSubscriptionsResource
Constructors
TopicSubscriptionsResource(IClientService)
Constructs a new resource.
Declaration
public TopicSubscriptionsResource(IClientService service)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
Create(TopicSubscription, string)
Creates a TopicSubscription. Subscribes an app installation instance (by registration_id, either FID or FCM Token) to a topicSubscription. Returns a TopicSubscription if it is created successfully. If the subscription already exists, returns error of ALREADY_EXISTS.
Declaration
public virtual ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.CreateRequest Create(TopicSubscription body, string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| TopicSubscription | body | The body of the request. |
| string | parent | Required. The parent resource where this subscription will be created. Format: projects/{project}/registrations/{registration} The {registration} part can be an FID or an FCM Token. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.CreateRequest |
Delete(string)
Deletes a TopicSubscription.
Declaration
public virtual ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.DeleteRequest Delete(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the topic subscription to delete. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.DeleteRequest |
Get(string)
Gets a TopicSubscription.
Declaration
public virtual ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.GetRequest Get(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the topic subscription to retrieve. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.GetRequest |
List(string)
Lists TopicSubscriptions for a given app instance.
Declaration
public virtual ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.ListRequest List(string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent resource, which owns this collection of subscriptions. Format: projects/{project}/registrations/{registration} The {registration} part can be an FID or an FCM Token. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.ListRequest |
Patch(TopicSubscription, string)
Updates a TopicSubscription. Subscribes an app installation instance by registration_id, either FID or FCM Token, to a topicSubscription. Returns an existing TopicSubscription or creates a new one if it does not exist.
Declaration
public virtual ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.PatchRequest Patch(TopicSubscription body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| TopicSubscription | body | The body of the request. |
| string | name | Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID). |
Returns
| Type | Description |
|---|---|
| ProjectsResource.RegistrationsResource.TopicSubscriptionsResource.PatchRequest |