Class OAuthRequirements (2.15.0)

public sealed class OAuthRequirements : IMessage<OAuthRequirements>, IEquatable<OAuthRequirements>, IDeepCloneable<OAuthRequirements>, IBufferMessage, IMessage

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf.

OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means.

In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs.

When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice.

Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.

Inheritance

object > OAuthRequirements

Implements

IMessage OAuthRequirements, IEquatable OAuthRequirements, IDeepCloneable OAuthRequirements, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

OAuthRequirements()

public OAuthRequirements()

OAuthRequirements(OAuthRequirements)

public OAuthRequirements(OAuthRequirements other)

Parameter
Name	Description
`other`	`OAuthRequirements`

Fields

CanonicalScopesFieldNumber

public const int CanonicalScopesFieldNumber = 1

Field number for the "canonical_scopes" field.

Field Value
Type	Description
`int`

Properties

CanonicalScopes

public string CanonicalScopes { get; set; }

The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted.

Example:

 canonical_scopes: https://www.googleapis.com/auth/calendar,
                   https://www.googleapis.com/auth/calendar.read

Property Value
Type	Description
`string`

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Parser

public static MessageParser<OAuthRequirements> Parser { get; }

Property Value
Type	Description
`MessageParserOAuthRequirements`

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
`int`	The number of bytes required to write this message to a coded output stream.

Clone()

public OAuthRequirements Clone()

Creates a deep clone of this object.

Returns
Type	Description
`OAuthRequirements`	A deep clone of this object.

Equals(OAuthRequirements)

public bool Equals(OAuthRequirements other)

Parameter
Name	Description
`other`	`OAuthRequirements`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(OAuthRequirements)

public void MergeFrom(OAuthRequirements other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`OAuthRequirements`

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
`input`	`CodedInputStream`

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
`output`	`CodedOutputStream` Coded output stream to write the data to. Must not be null.