Skip to content

saveImageToPhotosAlbum ​

接口说明 ​

saveImageToPhotosAlbum:options: 用于将指定路径的图片保存到设备系统相册。

调用方需要通过 SUDOPSaveImageToPhotosAlbumOptions 传入本地图片文件路径。SDK 会根据传入的 filePath 读取图片并执行保存到相册的操作。

类型声明 ​

objectivec
@interface SUDOPSaveImageToPhotosAlbumOptions : NSObject

@property(nonatomic, strong) NSString *filePath;

@end

方法声明 ​

objectivec
/**
 Saves an image to the device's photo album.
 @param stateHandle The state handle object that manages the operation state and callbacks.
 @param options The options configuration for saving the image to the photo album.
 */
- (void)saveImageToPhotosAlbum:(id<SUDOPStateHandle>)stateHandle
                       options:(SUDOPSaveImageToPhotosAlbumOptions *)options;

参数说明 ​

SUDOPSaveImageToPhotosAlbumOptions ​

参数类型是否必填说明
filePathNSString *是需要保存到系统相册的图片文件路径。

方法参数 ​

参数类型是否必填说明
stateHandleid<SUDOPStateHandle>是状态句柄对象,用于管理当前操作状态及回调。
optionsSUDOPSaveImageToPhotosAlbumOptions *是保存图片到相册的配置对象,包含图片文件路径。

使用示例 ​

objectivec
id<SUDOPStateHandle> stateHandle = self.stateHandle;

SUDOPSaveImageToPhotosAlbumOptions *options = [[SUDOPSaveImageToPhotosAlbumOptions alloc] init];
options.filePath = @"/var/mobile/Containers/Data/Application/xxx/Documents/example.png";

[self saveImageToPhotosAlbum:stateHandle options:options];

处理流程 ​

  1. 业务侧准备需要保存的图片文件。
  2. 确认图片文件已写入本地,并获取对应的文件路径。
  3. 创建 SUDOPSaveImageToPhotosAlbumOptions 对象。
  4. 设置 options.filePath 为本地图片文件路径。
  5. 调用 saveImageToPhotosAlbum:options: 发起保存图片到相册操作。
  6. SDK 根据传入路径读取图片并保存到系统相册。
  7. 保存结果通常通过 SDK 回调或状态回调通知业务侧。

注意事项 ​

  • stateHandle 不应为空,否则 SDK 可能无法正确管理当前操作状态或回调。
  • options 不应为空。
  • filePath 不应为空,且应指向一个真实存在的本地图片文件。
  • 调用前建议确认文件路径可访问,避免因文件不存在或无读取权限导致保存失败。
  • 保存到系统相册前,需要确保 App 已具备相册写入权限。
  • 如果系统尚未授权相册写入权限,业务侧应根据实际接入方式触发授权流程或处理失败回调。
  • 该方法无同步返回值,保存结果应以 SDK 回调或系统保存结果为准。