2022/8/10

【Swift UI】SNSシェアボタンの作成方法！UIActivityViewControllerの使い方

この記事からわかること

Swift UIでシェアボタンの作成方法
SNS(Twitter/LINEなど)にシェアするには？
UIActivityViewControllerクラスの使い方
UIViewControllerのpresentメソッド
シェアするアプリを指定するexcludedActivityTypes
日本語化する方法

index

[open]

Swift UIでシェア機能を実装する方法
UIActivityViewControllerクラスとは？
アイテムの指定方法
UIViewController.presentメソッド
rootViewControllerを取得
Swift UIで使ってみる
シェアするアプリを指定するexcludedActivityTypes
日本語化する

＼アプリをリリースしました／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

Swift UIでTwitterやLINEなどのSNSにアプリをシェアするボタンの実装方法をまとめていきます。

Swift UIでシェア機能を実装する方法

今回は繰り返し使えるように引数にシェアしたい内容を受け取るメソッドとして定義しています。

 // シェアボタン
func shareApp(shareText: String, shareImage: Image, shareLink: String) {
    let items = [shareText, shareImage, URL(string: shareLink)!] as [Any]
    let activityVC = UIActivityViewController(activityItems: items, applicationActivities: nil)
    let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene
    let rootVC = windowScene?.windows.first?.rootViewController
    rootVC?.present(activityVC, animated: true,completion: {})
}

Button(action: {
    shareApp(shareText: "mappingというアプリを使ってみてね♪", shareImage: Image("icon"), shareLink: "https://appdev-room.com/")
}) {
    HStack{
        Image(systemName:"star.bubble").frame(width: 30)
        Text("シェアする")
    }
}

シェアボタンを実装するために重要なポイント

シェアできるアイテムの種類
UIActivityViewControllerクラス：シェアビューの構築
UIViewController.presentメソッド：モーダル表示

UIActivityViewControllerクラスとは？

公式リファレンス：UIActivityViewController

SNSへのシェア機能を実装するのに重要なのはUIActivityViewControllerクラスです。このクラスはSNSへのシェアや電子メールによる送信など標準的なサービスを提供してくれるビューコントローラー(UIViewController)の役割を持っています。

open class UIActivityViewController : UIViewController

難しく書くとこんな感じですが要するにiPhoneの下部からこのように出てくるシェア機能を実装するためのクラスになります。

シェアできる内容(アイテム)は以下の3種類まで対応しています。

シェアできるアイテムの種類

テキスト
画像
URL

アイテムの指定方法

シェアするアイテムはUIActivityViewControllerをインスタンス化する際の引数activityItemsに指定します。定義を見てみると[Any]となっているので異なるデータ型を保持する配列形式となります。applicationActivitiesはアプリ固有のサービスを実装したい場合に設定します。不要であればnilを指定します。

UIActivityViewControllerイニシャライザ

init(
    activityItems: [Any],
    applicationActivities: [UIActivity]?
)

ViewControllerとしてインスタンス化する際にアイテムを引数に設定します。直接引数に指定する場合は以下の通りでOKですが変数に格納して渡す際は[Any]への型変換が必要になります。

let activityVC = UIActivityViewController(activityItems:  ["mappingというアプリを使ってみてね♪",Image(systemName: "globe.asia.australia"), URL(string: "https://appdev-room.com/")!], applicationActivities: nil)

変数に格納する場合

let items = ["mappingというアプリを使ってみてね♪",Image(systemName: "globe.asia.australia"), URL(string: "https://appdev-room.com/")!] as [Any]
let activityVC = UIActivityViewController(activityItems: items, applicationActivities: nil)

これで表示するシェアビュー(UIActivityViewController：UIViewControllerインスタンス)の構築が完了しました。続いてこれを表示させる処理を記述していきます。

UIViewController.presentメソッド

公式リファレンス：UIViewController.presentメソッド

作成したUIActivityViewController(UIViewController)インスタンスをiPhone下部に表示するにはViewControllerインスタンスをモーダルに表示できるUIViewControllerのpresentメソッドを使用します。

func present(
    _ viewControllerToPresent: UIViewController,
    animated flag: Bool,
    completion: (() -> Void)? = nil
)

各引数の意味

_ viewControllerToPresent：モーダル表示するビュー
animated：アニメーションの有効/無効
completion：表示後に実行する処理があれば記述するブロック

このメソッドでシェアビューを表示するためには表示元となるビューの特定が必要です。

rootViewControllerを取得

公式リファレンス：rootViewControllerプロパティ

rootViewControllerを取得するにはアプリケーションを制御、管理するUIApplicationクラスからメモリ内でアクティブになっているシーンを取得しそのシーンのrootViewControllerプロパティにアクセスします。

let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene
let rootVC = windowScene?.windows.first?.rootViewController

あとは取得したrootViewControllerからpresentメソッドを呼び出して引数にシェアビューを指定すればOKです。

rootVC?.present(activityVC, animated: true,completion: {} )

完成したシェアメソッド

// シェアボタン
func shareApp(shareText: String, shareImage: Image, shareLink: String) {
    let items = [shareText, shareImage, URL(string: shareLink)!] as [Any]
    let activityVC = UIActivityViewController(activityItems: items, applicationActivities: nil)
    let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene
    let rootVC = windowScene?.windows.first?.rootViewController
    rootVC?.present(activityVC, animated: true,completion: {})
}

Swift UIで使ってみる

あとはボタンなどのアクションでメソッドを呼び出せばシェアビューをモーダル表示させることができるようになります。

Button(action: {
    shareApp(shareText: "mappingというアプリを使ってみてね♪", shareImage: Image(systemName: "globe.asia.australia"), shareLink: "https://appdev-room.com/")
}) {
    HStack{
        Image(systemName:"star.bubble").frame(width: 30)
        Text("シェアする")
    }
}

シェアするアプリを指定するexcludedActivityTypes

シェアするアプリやツールなどは何も指定しない場合、そのデバイスにインストールされているシェア可能なアプリ全てが自動で表示されます。

この中でもシェアさせたいアプリを限定するために、除外する設定ができるのがUIActivityViewControllerクラスのexcludedActivityTypesプロパティです。アプリ(ActivityType)を除外する設定なのでこのプロパティに値を渡さなければ自動で全てが表示されます。

使用方法

使用するにはインスタンス化したUIActivityViewControllerのexcludedActivityTypesプロパティに配列形式で除外したいアプリを渡すだけです。

let activityVC = UIActivityViewController(activityItems: items, applicationActivities: nil)
activityVC.excludedActivityTypes = [
    // 不要なアプリ(UIActivityType)を列挙する
    UIActivity.ActivityType.message,
    UIActivity.ActivityType.mail
]

UIActivity.ActivityType

ActivityType	概要
addToReadingList	Safariのリーディングリストへ追加
airDrop	Air Dropで近くの端末にシェア
assignToContact	連絡先にアイテムを渡す
copyToPasteboard	ペーストボード(クリップボード)へコピー
mail	メールでシェア
message	メッセージでシェア
openInIBooks	iBooksにPDFとして保存
postToFacebook	Facebookでシェア
postToFlickr	Flickrでシェア
postToTencentWeibo	Tencent Weiboでシェア
postToTwitter	Twitterでシェア
postToVimeo	Viemoでシェア
postToWeibo	Weiboでシェア
print	印刷
saveToCameraRoll	カメラロールに保存
markupAsPDF	PDFを作成