Show / Hide Table of Contents

Class PublicationsResource.ReadersResource

The "readers" collection of methods.

Inheritance
object
PublicationsResource.ReadersResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.SubscriptionLinking.v1
Assembly: Google.Apis.SubscriptionLinking.v1.dll
Syntax
public class PublicationsResource.ReadersResource

Constructors

ReadersResource(IClientService)

Constructs a new resource.

Declaration
public ReadersResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Delete(string)

Removes a publication reader, effectively severing the association with a Google user. If force is set to true, any entitlements for this reader will also be deleted. (Otherwise, the request will only work if the reader has no entitlements.) - If the reader does not exist, return NOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (or unset) and entitlements are present.

Declaration
public virtual PublicationsResource.ReadersResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The resource name of the reader. Format: publications/{publication_id}/readers/{ppid}

Returns
Type Description
PublicationsResource.ReadersResource.DeleteRequest

Get(string)

Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist.

Declaration
public virtual PublicationsResource.ReadersResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The resource name of the reader. Format: publications/{publication_id}/readers/{ppid}

Returns
Type Description
PublicationsResource.ReadersResource.GetRequest

GetEntitlements(string)

Gets the reader entitlements for a publication reader. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.

Declaration
public virtual PublicationsResource.ReadersResource.GetEntitlementsRequest GetEntitlements(string name)
Parameters
Type Name Description
string name

Required. The name of the reader entitlements to retrieve. Format: publications/{publication_id}/readers/{reader_id}/entitlements

Returns
Type Description
PublicationsResource.ReadersResource.GetEntitlementsRequest

UpdateEntitlements(ReaderEntitlements, string)

Updates the reader entitlements for a publication reader. The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.

Declaration
public virtual PublicationsResource.ReadersResource.UpdateEntitlementsRequest UpdateEntitlements(ReaderEntitlements body, string name)
Parameters
Type Name Description
ReaderEntitlements body

The body of the request.

string name

Output only. The resource name of the singleton.

Returns
Type Description
PublicationsResource.ReadersResource.UpdateEntitlementsRequest
In this article
Back to top Generated by DocFX