PCAPI

Version 1.6 - Updated on 11/17/2016

Superclass: NSObject
Declared In: PCAPI.h

Contents

• PCAPI
  • Introduction
  • Methods
    • cancelAPI
  • Properties
    • apiID
    • requestBody
    • requestHeaders
    • requestMethod
    • requestURL
    • requestURLString
    • serverBaseURL
    • sessionID

Introduction

Base class for all HTTP queries.

Methods

cancelAPI

- (void)cancelAPI; 

• Discussion
  Call this method to cancel the ongoing webservice operation.

Properties

apiID

@property (nonatomic,
    assign,
    readonly) NSUInteger apiID; 

• Discussion
  Returns a unique ID of the API, which is the task identifier of the API.

requestBody

@property (nonatomic,
    strong,
    readonly) NSData *requestBody; 

• Discussion
  Request body

requestHeaders

@property (nonatomic,
    strong,
    readonly) NSDictionary *requestHeaders; 

• Discussion
  Request headers

requestMethod

@property (nonatomic,
    copy,
    readonly) NSString *requestMethod; 

• Discussion
  Type of an HTTP request, such as GET, POST or PUT. Default is GET.

requestURL

@property (nonatomic,
    strong,
    readonly) NSURL *requestURL; 

• Discussion
  Complete request URL

requestURLString

@property (nonatomic,
    copy,
    readonly) NSString *requestURLString;

• Discussion
  Complete request URL string.

serverBaseURL

@property (nonatomic,
    copy,
    readonly) NSString *serverBaseURL; 

• Discussion
  Base server URL

sessionID

@property (nonatomic,
    copy,
    readonly) NSString *sessionID; 

• Discussion
  Returns the ID of NSURLSession associated with this API. None, if it is not a background session.

Copyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.