AMAAppMetricaCrashReporting 协议

协议 AMAAppMetricaCrashReporting 包含自定义错误消息和崩溃消息的方法。

Instance methods

-reportNSError:onFailure:

向 AppMetrica 发送 NSError 消息。

-reportNSError:options:onFailure:

Sends an NSError 消息,包含额外的消息自定义选项。

-reportError:onFailure:

发送一条关于匹配 AMAErrorRepresentable 协议的错误的消息。

-reportError:options:onFailure:

发送一个关于错误的消息,符合 AMAErrorRepresentable 协议,并提供额外的消息自定义选项。

-setErrorEnvironmentValue:forKey:

设置与错误和崩溃相关的键值对。

-pluginExtension:

Creates an AMAAppMetricaPlugins 实例,可以将插件事件发送到主 API 密钥。

Method descriptions

-reportNSError:onFailure:

- (void)reportNSError:(NSError *)error
            onFailure:(nullable void (^)(NSError *error))onFailure report(nserror:onFailure:);

发送一个NSError消息,该消息在域、userInfo和其他属性上受到一定限制。

您可以启用 NSError 回溯,方法是使用 AMABacktraceErrorKey 常量在 userInfo 属性中。

限制:

  • 域:不超过200个字符。
  • userInfo:最多50对键值对,键长度不超过100个字符,值长度不超过2000个字符。
  • NSUnderlyingErrorKey:在 userInfo 中使用此键可让您包含最多 10 个错误。
  • AMABacktraceErrorKey:在 userInfo 中使用此键可让您在回溯中包含最多 200 个堆栈帧。

AppMetrica 如果值超出指定限制,则会被截断。

参数:

错误

表示要报告的错误的 NSError 对象。 AppMetrica 使用 domain 和 code 属性来对错误进行分组。

OnFailure

若在发送消息时发生错误,要调用的回调方法。 错误作为参数传递。

-reportNSError:options:onFailure:

- (void)reportNSError:(NSError *)error
              options:(AMAErrorReportingOptions)options
            onFailure:(nullable void (^)(NSError *error))onFailure report(nserror:options:onFailure:);

发送一个自定义的 NSError 消息,该消息遵循对 domain、userInfo 和其他属性的限制。

您可以通过在 userInfo 属性中使用 AMABacktraceErrorKey 常量来启用 NSError 的回溯。

限制:

  • 域:长度不超过200个字符。
  • userInfo:最多50对键值对,键长度不超过100个字符,值长度不超过2000个字符。
  • NSUnderlyingErrorKey:在 userInfo 中使用此键可让您包含最多 10 个错误。
  • AMABacktraceErrorKey:在 userInfo 中使用此键可让您在回溯中包含最多 200 个堆栈帧。

AppMetrica 会截断超出任何限制的值。

参数:

错误

表示要报告的错误的 NSError 对象。 AppMetrica 使用 域 和 代码 属性来分组错误。

选项

额外的 AMAErrorReportingOptions 选项,用于定义错误消息的发送方式。

OnFailure

若在发送消息时发生错误,要调用的回调方法。 错误作为参数传递。

-reportError:onFailure:

- (void)reportError:(id<AMAErrorRepresentable>)error
          onFailure:(nullable void (^)(NSError *error))onFailure report(error:onFailure:);

发送一条关于匹配 AMAErrorRepresentable 协议的错误的消息。

参数:

错误

匹配 AMAErrorRepresentable 协议的错误。

OnFailure

若在发送消息时发生错误,要调用的回调方法。 错误作为参数传递。

-报告错误:选项:失败时:

- (void)reportError:(id<AMAErrorRepresentable>)error
            options:(AMAErrorReportingOptions)options
          onFailure:(nullable void (^)(NSError *error))onFailure report(error:options:onFailure:);

发送一个关于符合 AMAErrorRepresentable 协议的错误的消息,并提供额外的自定义消息选项。

参数:

错误

匹配 AMAErrorRepresentable 协议的错误。

选项

额外的 AMAErrorReportingOptions 选项,用于定义错误消息的发送方式。

OnFailure

若在发送消息时发生错误,要调用的回调方法。 错误作为参数传递。

-setErrorEnvironmentValue:forKey:

- (void)setErrorEnvironmentValue:(nullable NSString *)value
                          forKey:(NSString *)key set(errorEnvironmentValue:forKey:);

设置与错误和崩溃相关的键值对。 AppMetrica 将其用作未处理异常的附加信息。

参数:

value

要与键关联的值。 传递 nil 会删除之前设置的键值对。

key

键与值相关联。

-pluginExtension:

- (id<AMAAppMetricaPlugins>)pluginExtension;

Creates an AMAAppMetricaPlugins 实例,可以将插件事件发送到主 API 密钥。 您可以每次都申请,也可以保存参考信息以供后续使用。 要使用此扩展,首先用 [AMAAppMetrica activateWithConfiguration:] 方法激活 AppMetrica。

返回:

插件扩展实例。