removeAttribute (iOS SDK API)

Syntax

removeAttribute:(NSString*)name;
NewRelic.removeAttribute()

Removes the specified session attribute.

Requirements

Compatible with all agent versions.

Description

This method removes the attribute specified by the name string from the session.

For context on how to use this API, see the documentation about sending custom attributes and events:

• Objective-C
• Swift

Parameters

Return values

Returns true if it succeeds, or false if it doesn't.

Examples

Objective-C

Method:

+ (BOOL) removeAttribute:(NSString*)name;

Example:

Removes the session attribute specified by NSString*; for example, rate.

BOOL attributeRemoved = [NewRelic removedAttribute@"rate"];

Swift

Method:

NewRelic.removeAttribute(name: String!) -> Bool

Example:

Removes a session attribute named rate:

let attributeRemoved = NewRelic.removedAttribute("rate")