Show / Hide Table of Contents

Class EmailPreferencesService.EmailPreferencesServiceClient

Client for EmailPreferencesService

Inheritance
object
ClientBase
ClientBase<EmailPreferencesService.EmailPreferencesServiceClient>
EmailPreferencesService.EmailPreferencesServiceClient
Inherited Members
ClientBase<EmailPreferencesService.EmailPreferencesServiceClient>.WithHost(string)
ClientBase.CallInvoker
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Shopping.Merchant.Accounts.V1
Assembly: Google.Shopping.Merchant.Accounts.V1.dll
Syntax
public class EmailPreferencesService.EmailPreferencesServiceClient : ClientBase<EmailPreferencesService.EmailPreferencesServiceClient>

Constructors

EmailPreferencesServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected EmailPreferencesServiceClient()

EmailPreferencesServiceClient(CallInvoker)

Creates a new client for EmailPreferencesService that uses a custom CallInvoker.

Declaration
public EmailPreferencesServiceClient(CallInvoker callInvoker)
Parameters
Type Name Description
CallInvoker callInvoker

The callInvoker to use to make remote calls.

EmailPreferencesServiceClient(ChannelBase)

Creates a new client for EmailPreferencesService

Declaration
public EmailPreferencesServiceClient(ChannelBase channel)
Parameters
Type Name Description
ChannelBase channel

The channel to use to make remote calls.

EmailPreferencesServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration
protected EmailPreferencesServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration

The client configuration.

Methods

GetEmailPreferences(GetEmailPreferencesRequest, CallOptions)

Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

Declaration
public virtual EmailPreferences GetEmailPreferences(GetEmailPreferencesRequest request, CallOptions options)
Parameters
Type Name Description
GetEmailPreferencesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
EmailPreferences

The response received from the server.

GetEmailPreferences(GetEmailPreferencesRequest, Metadata, DateTime?, CancellationToken)

Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

Declaration
public virtual EmailPreferences GetEmailPreferences(GetEmailPreferencesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetEmailPreferencesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
EmailPreferences

The response received from the server.

GetEmailPreferencesAsync(GetEmailPreferencesRequest, CallOptions)

Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

Declaration
public virtual AsyncUnaryCall<EmailPreferences> GetEmailPreferencesAsync(GetEmailPreferencesRequest request, CallOptions options)
Parameters
Type Name Description
GetEmailPreferencesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<EmailPreferences>

The call object.

GetEmailPreferencesAsync(GetEmailPreferencesRequest, Metadata, DateTime?, CancellationToken)

Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

Declaration
public virtual AsyncUnaryCall<EmailPreferences> GetEmailPreferencesAsync(GetEmailPreferencesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetEmailPreferencesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<EmailPreferences>

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration
protected override EmailPreferencesService.EmailPreferencesServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration
Returns
Type Description
EmailPreferencesService.EmailPreferencesServiceClient
Overrides
Grpc.Core.ClientBase<Google.Shopping.Merchant.Accounts.V1.EmailPreferencesService.EmailPreferencesServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateEmailPreferences(UpdateEmailPreferencesRequest, CallOptions)

Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account.

Preferences which are not explicitly selected in the update mask will not be updated.

It is invalid for updates to specify an UNCONFIRMED opt-in status value.

Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

Declaration
public virtual EmailPreferences UpdateEmailPreferences(UpdateEmailPreferencesRequest request, CallOptions options)
Parameters
Type Name Description
UpdateEmailPreferencesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
EmailPreferences

The response received from the server.

UpdateEmailPreferences(UpdateEmailPreferencesRequest, Metadata, DateTime?, CancellationToken)

Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account.

Preferences which are not explicitly selected in the update mask will not be updated.

It is invalid for updates to specify an UNCONFIRMED opt-in status value.

Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

Declaration
public virtual EmailPreferences UpdateEmailPreferences(UpdateEmailPreferencesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateEmailPreferencesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
EmailPreferences

The response received from the server.

UpdateEmailPreferencesAsync(UpdateEmailPreferencesRequest, CallOptions)

Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account.

Preferences which are not explicitly selected in the update mask will not be updated.

It is invalid for updates to specify an UNCONFIRMED opt-in status value.

Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

Declaration
public virtual AsyncUnaryCall<EmailPreferences> UpdateEmailPreferencesAsync(UpdateEmailPreferencesRequest request, CallOptions options)
Parameters
Type Name Description
UpdateEmailPreferencesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<EmailPreferences>

The call object.

UpdateEmailPreferencesAsync(UpdateEmailPreferencesRequest, Metadata, DateTime?, CancellationToken)

Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account.

Preferences which are not explicitly selected in the update mask will not be updated.

It is invalid for updates to specify an UNCONFIRMED opt-in status value.

Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

Declaration
public virtual AsyncUnaryCall<EmailPreferences> UpdateEmailPreferencesAsync(UpdateEmailPreferencesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateEmailPreferencesRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<EmailPreferences>

The call object.

In this article
Back to top Generated by DocFX