GPBApi Class Reference

Api is a light-weight descriptor for a protocol buffer service. More...

#import <Api.pbobjc.h>

Inheritance diagram for GPBApi:

Properties
NSString *	name
NSMutableArray< GPBMethod * > *	methodsArray
	The methods of this api, in unspecified order. More...
NSUInteger	methodsArray_Count
	The number of items in methodsArray without causing the array to be created. More...
NSMutableArray< GPBOption * > *	optionsArray
	Any metadata attached to the API. More...
NSUInteger	optionsArray_Count
	The number of items in optionsArray without causing the array to be created. More...
NSString *	version
GPBSourceContext *	sourceContext
BOOL	hasSourceContext
	Test to see if sourceContext has been set. More...
NSMutableArray< GPBMixin * > *	mixinsArray
	Included APIs. See [Mixin][]. More...
NSUInteger	mixinsArray_Count
	The number of items in mixinsArray without causing the array to be created. More...
enum GPBSyntax	syntax
	The source syntax of the service. More...
Properties inherited from GPBMessage
GPBUnknownFieldSet *	unknownFields
BOOL	initialized
	Are all required fields set in the message and all embedded messages. More...

Additional Inherited Members
Instance Methods inherited from GPBMessage
(instancetype)	- initWithData:error:
(instancetype)	- initWithData:extensionRegistry:error:
(instancetype)	- initWithCodedInputStream:extensionRegistry:error:
(void)	- writeToCodedOutputStream:
	Writes out the message to the given output stream. More...
(void)	- writeToOutputStream:
	Writes out the message to the given output stream. More...
(void)	- writeDelimitedToCodedOutputStream:
(void)	- writeDelimitedToOutputStream:
(nullable NSData *)	- data
(NSData *)	- delimitedData
(size_t)	- serializedSize
(GPBDescriptor *)	- descriptor
	Return the descriptor for the message. More...
(BOOL)	- hasExtension:
	Test to see if the given extension is set on the message. More...
(nullable id)	- getExtension:
(void)	- setExtension:value:
(void)	- addExtension:value:
(void)	- setExtension:index:value:
(void)	- clearExtension:
	Clears the given extension for this message. More...
(void)	- clear
	Resets all of the fields of this message to their default values. More...
(void)	- mergeFromData:extensionRegistry:
(void)	- mergeFrom:
Class Methods inherited from GPBMessage
(instancetype)	+ message
	Returns an autoreleased instance. More...
(instancetype)	+ parseFromData:error:
(instancetype)	+ parseFromData:extensionRegistry:error:
(instancetype)	+ parseFromCodedInputStream:extensionRegistry:error:
(instancetype)	+ parseDelimitedFromCodedInputStream:extensionRegistry:error:
(GPBDescriptor *)	+ descriptor
	Return the descriptor for the message class. More...

Detailed Description

Api is a light-weight descriptor for a protocol buffer service.

Property Documentation

hasSourceContext

- (BOOL) hasSourceContext

readwritenonatomicassign

Test to see if sourceContext has been set.

methodsArray

- (NSMutableArray<GPBMethod*>*) methodsArray

readwritenonatomicstrong

The methods of this api, in unspecified order.

methodsArray_Count

- (NSUInteger) methodsArray_Count

readnonatomicassign

The number of items in methodsArray without causing the array to be created.

mixinsArray

- (NSMutableArray<GPBMixin*>*) mixinsArray

readwritenonatomicstrong

Included APIs. See [Mixin][].

mixinsArray_Count

- (NSUInteger) mixinsArray_Count

readnonatomicassign

The number of items in mixinsArray without causing the array to be created.

name

- (NSString*) name

readwritenonatomiccopy

The fully qualified name of this api, including package name followed by the api's simple name.

optionsArray

- (NSMutableArray<GPBOption*>*) optionsArray

readwritenonatomicstrong

Any metadata attached to the API.

optionsArray_Count

- (NSUInteger) optionsArray_Count

readnonatomicassign

The number of items in optionsArray without causing the array to be created.

sourceContext

- (GPBSourceContext*) sourceContext

readwritenonatomicstrong

Source context for the protocol buffer service represented by this message.

syntax

- (enum GPBSyntax) syntax

readwritenonatomicassign

The source syntax of the service.

version

- (NSString*) version

readwritenonatomiccopy

A version string for this api. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

The major version is also reflected in the package name of the API, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, none-GA apis.

---

The documentation for this class was generated from the following file:

• Source/ThirdParty/libwebrtc/Source/third_party/protobuf/objectivec/google/protobuf/Api.pbobjc.h