FIRExceptionModel.h 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. // Copyright 2020 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #import <Foundation/Foundation.h>
  15. #import "FIRStackFrame.h"
  16. NS_ASSUME_NONNULL_BEGIN
  17. /**
  18. * The Firebase Crashlytics ExceptionModel provides a way to report custom exceptions
  19. * to Crashlytics that came from a runtime environment outside of the native
  20. * platform Crashlytics is running in.
  21. */
  22. NS_SWIFT_NAME(ExceptionModel)
  23. @interface FIRExceptionModel : NSObject
  24. /** :nodoc: */
  25. - (instancetype)init NS_UNAVAILABLE;
  26. /**
  27. * Initializes an ExceptionModel with the given required fields.
  28. *
  29. * @param name - typically the type of the Exception class
  30. * @param reason - the human-readable reason the issue occurred
  31. */
  32. - (instancetype)initWithName:(NSString *)name reason:(NSString *)reason;
  33. /**
  34. * Creates an ExceptionModel with the given required fields.
  35. *
  36. * @param name - typically the type of the Exception class
  37. * @param reason - the human-readable reason the issue occurred
  38. */
  39. + (instancetype)exceptionModelWithName:(NSString *)name
  40. reason:(NSString *)reason NS_SWIFT_UNAVAILABLE("");
  41. /**
  42. * A list of stack frames that make up the stack trace. The order of the stack trace is top-first,
  43. * so typically the "main" function is the last element in this list.
  44. */
  45. @property(nonatomic, copy) NSArray<FIRStackFrame *> *stackTrace;
  46. @end
  47. NS_ASSUME_NONNULL_END