ServiceClient Properties, Methods, and Events

The ServiceClient component has the following properties, methods, and events. Design Properties are accessed from the Properties Grid. Access all other properties, methods, and events directly from Object Explorer or by using the Configure Type option.

 

Properties

Property

Description

Address

Gets or sets an optional address. When omitted, current binding's address from the Web Services Description Language (WSDL) is used. Type: String.

AllowAutoRedirect

Gets or sets a True/False value indicating whether the web service automatically follows redirects to another URL. This property is rarely set to True. The value is determined by the web service host. If set to True, the service can follow redirects. If set to False, it does not follow redirects.

Bindings

Browse the Bindings property in the Properties grid to open the Bindings Editor.

Note: Each binding now has Quota property. Use the Quota property if the connector cannot get a large data set from a server and you receive an error message such as "Error: The maximum message size quota for incoming messages (655536) has been exceeded. To increase the quota, use the MaxReceivedMessageSize property on the appropriate binding element. Adjust the quantity upward until the error is no longer generated.

BypassProxy

Gets or sets a True/False value that indicates whether a default proxy is used to access the service WSDL. Set to False to use the default proxy.

CurrentBinding

Sets the current binding with which to invoke service contract/method. Click the down arrow in this property to view all of the bindings set up for the service. 

KeepAlive

Gets or sets a True/False value that indicates whether the connection to the server is closed after the request completes. Set to True to close the connection.

LogImportErrors

Gets or sets a True/False value that indicates whether to log service WSDL metadata import errors. Set to True to log errors.

LogProcessingErrors

Gets or sets a True/False value that indicates whether to log service WSDL metadata processing errors. Set to True to log errors.

PreAuthenticate

Indicates whether to send an authenticate header with the web service request. Set to True to send an authenticate header.

UseDefaultCredentials

Gets or sets a True/False value indicating whether to use security credentials of the user running the application to access the service WSDL.

WSDL

Gets or sets the Services Description Language (WSDL) URL.

 

Methods:

Method

Description

Parameters

Return Type

CompareTo

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Returns a 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:

  • Less than zero –  This instance is less than obj.

  • Zero – This instance is equal to obj.

  • Greater than zero –  This instance is greater than obj.

Object obj

Int32

ContainsCookie

Returns True if the cookie is retrieved in the last service request.

String name

Boolean

GetCookie

Returns the value of the cookie from the last service request or null if the cookie is not found.

String name

Object

SetCookie

Sets the value of the cookie for the service request.

String name, Object value

Void

 


Privacy | Trademarks | Terms of Use | Feedback

Updated: 18 June 2020

© 2016 - 2020 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label