Skip to content

hideToast ​

接口说明 ​

hideToast:options: 用于隐藏当前正在展示的 Toast 提示消息。

通常情况下,Toast 会在设定的 duration 到达后自动消失;当业务需要提前关闭 Toast,例如关闭加载中 Toast、页面切换或任务结束时,可以调用该接口主动隐藏。

类型声明 ​

objectivec
@interface SUDOPHideToastOptions : NSObject

@property(nonatomic, assign) BOOL noConflict;

@end

方法声明 ​

objectivec
/**
 Hides the currently displayed toast message.
 @param stateHandle The state handle object that manages the operation state and callbacks.
 @param options The options configuration for hiding the toast.
 */
- (void)hideToast:(id<SUDOPStateHandle>)stateHandle
          options:(SUDOPHideToastOptions *)options;

参数说明 ​

SUDOPHideToastOptions ​

参数类型是否必填说明
noConflictBOOL否是否启用非冲突隐藏策略。具体行为以 SDK 实现为准,通常用于避免隐藏其他业务或其他调用方正在展示的 Toast。

方法参数 ​

| 参数 | 类型 | 是否必填 | 说明 | | --- | --- | --- | | stateHandle | id<SUDOPStateHandle> | 是 | 状态句柄对象,用于管理当前操作状态及回调。 | | options | SUDOPHideToastOptions * | 是 | 隐藏 Toast 的配置对象。 |

使用示例 ​

主动隐藏 Toast ​

objectivec
id<SUDOPStateHandle> stateHandle = self.stateHandle;

SUDOPHideToastOptions *options = [[SUDOPHideToastOptions alloc] init];
options.noConflict = YES;

[self hideToast:stateHandle options:options];

配合加载中 Toast 使用 ​

objectivec
// 展示加载中 Toast
SUDOPShowToastOptions *showOptions = [[SUDOPShowToastOptions alloc] init];
showOptions.title = @"加载中";
showOptions.icon = kSUDOPShowToastOptionsIconTypeLoading;
showOptions.duration = 10000;
showOptions.mask = YES;

[self showToast:self.stateHandle options:showOptions];

// 异步任务完成后隐藏 Toast
SUDOPHideToastOptions *hideOptions = [[SUDOPHideToastOptions alloc] init];
hideOptions.noConflict = YES;

[self hideToast:self.stateHandle options:hideOptions];

处理流程 ​

  1. 当前页面或全局环境中已存在通过 showToast:options: 展示的 Toast。
  2. 业务侧创建 SUDOPHideToastOptions 对象。
  3. 根据需要设置 noConflict。
  4. 调用 hideToast:options:。
  5. SDK 隐藏当前正在展示的 Toast。
  6. 通过状态回调返回执行结果或异常信息。

注意事项 ​

  • hideToast:options: 可用于提前关闭由 showToast:options: 展示的 Toast。
  • 如果 Toast 已经自动消失,再调用该方法可能不会产生可见效果。
  • stateHandle 不应为空,否则 SDK 可能无法正确管理当前操作状态或回调。
  • options 不应为空。
  • noConflict 的具体语义以 SDK 实际实现为准;如果 SDK 支持多 Toast 场景,该字段可能用于避免误隐藏其他调用上下文中的 Toast。
  • 对于 icon = loading 或较长 duration 的 Toast,建议在任务结束后主动调用 hideToast:options:。
  • 该方法无同步返回值,隐藏结果或异常信息应以 SDK 回调或状态回调为准。